Skip to main content

Base URL

Every endpoint is served over HTTPS, and every example in these docs uses this host.

Authentication

Every endpoint except POST /oauth/token expects a bearer token:
Tokens come from the client credentials grant and last an hour. See Authentication for how to create an API client and what its scopes mean.

Media types

The API is versioned through a vendor media type. For convenience, application/json is also accepted and maps to the latest version of an endpoint. For production integrations, sending the versioned media type is recommended.

Status codes

How failure bodies are shaped is covered in Error handling.