API Reference

The GTM Engine REST API gives you programmatic access to your CRM records, pipelines, and users. Use it to integrate GTM Engine with your own tools, build custom automations, or sync data with external systems.

Authentication

All endpoints require an API key passed as a Bearer token in the Authorization header. Generate keys under Settings → Organization → API Keys in the app.

Authorization: Bearer gtm_...

Base URL

https://api.gtmengine.ai

All endpoints below are relative to this host (e.g. GET https://api.gtmengine.ai/v1/accounts).

Endpoints by resource

The API is grouped by resource. Pick a resource below to jump to its list endpoint, or use the sidebar to navigate to a specific operation.

Accounts — companies in your CRM. List · Get · Create · Update
Contacts — people in your CRM. List · Get · Create · Update
Opportunities — deals. List · Get · Create · Update
Pipelines — pipeline configurations. List · Get
Stages — stages within a pipeline. List · Get
Users — users in your organization. List · Get

Inbound webhooks

Beyond the CRM resources above, GTM Engine exposes a webhook ingestion endpoint so external systems can POST events that start your workflows. It's a receiver (not Bearer-authenticated, not in the OpenAPI spec) and is documented separately:

Webhook ingestion — endpoint, authentication modes, payload contract, and responses.

Conventions

IDs are UUIDs.
Pagination uses limit and offset query params on list endpoints; responses include a total count.
Errors return a JSON body with error (machine-readable code) and message (human-readable description). HTTP status codes follow REST conventions: 400 for validation errors, 401 for missing/invalid auth, 403 for permission denied, 404 for missing records, 429 for rate limiting, 5xx for server errors.
Timestamps are ISO-8601 UTC.

OpenAPI spec

The raw OpenAPI document is available at https://api.gtmengine.ai/openapi.json. You can use it to generate clients, write tests against contract changes, or import into Postman / Insomnia.