Skip to main content

​
Endpoint reference

The API endpoints section is generated directly from the committed OpenAPI 3.1 document. It currently contains:
  • 95 HTTP operations in total.
  • 86 tenant and participant /v1 operations.
  • Stable request, response, error, authentication, and idempotency contracts.
  • No retained deprecated operations.
Mintlify renders each operation’s description, path and query parameters, request body, authentication scheme, responses, and code examples. The interactive playground is disabled so this public site cannot collect a credential or mutate a tenant.
The canonical source remains shared/openapi.json in the Synapse repository. apps/docs/openapi.json is a checked-in deployment copy. Repository tests require the two files to be byte-for-byte identical.
For integration-wide conventions, start with the API overview. For credential selection, see authentication and scope.