HTTP reference
Tenant API reference.
Find an endpoint, check its required scope, and copy a request in your backend language. This reference is generated from the application’s OpenAPI schema and includes the operations available to CMS integrations.
Fundamentals
JSON over HTTPSRequest and response field names use snake_case.
Bearer authenticationPublic platform endpoints are marked “No token”. All others require a server token and scope.
Cursor paginationTreat cursors as opaque and follow returned next links or cursors.
Problem DetailsFailures return application/problem+json with an X-Request-ID.
Response objects
Use the operation below for request parameters and scopes. For the meaning of a returned field or what to save in your CMS, open one of these guides:
Current contract
Operations
Open an operation to inspect parameters, request body, required scope and documented responses.
Loading the tenant OpenAPI contract…
Refresh the page or open the tenant OpenAPI document directly.