Skip to main content
The reference documents the public contract of three services. Every page is generated from the same registry that defines the MCP tools (one endpoint per tool), so it matches what the server validates, not what someone remembered to write down.

​
Base URLs

Auth is the same everywhere: Authorization: Bearer <token> with an API key or JWT. The playground on each page can send real requests; point it at production and use a test team.

​
Reading an operation

Beyond the request and response schemas, each operation carries flags from the registry. They render in the description and as x-gtm-* extensions in the raw spec, so both a person and a client generator can act on them:

​
Deprecated means “not yet”, not “going away”

Operations marked deprecated are stub_501 endpoints: they validate the full request and then answer 501 not_implemented. The request contract is final, so you can build against it today; the marker exists so a generated client tells you not to ship against it yet. The reason is in the operation’s description.

​
Two serialization details

  • On GET and DELETE, object parameters (filter, sort) travel as JSON text in the query string, and array parameters repeat as name[]=value. Details in Pagination and filtering.
  • Success and error bodies are envelopes shared by every endpoint. Details in Envelopes and errors.