API reference

These APIs are HTTP JSON services described with OpenAPI 3. Use this page to inspect paths, parameters, request and response shapes, and status codes—then call the same URLs from your app or try calls here with Try it out.

Obtain a bearer token from the Authenticate tab first, then click Authorize, paste the token, and approve. The UI can remember it for this browser session. Other tabs (CRM, Email, SMS, Insights) each load their own spec; switch Servers per tab if needed.

Only the first operation expands by default; click a row to open bodies, query parameters, and documented responses. Use the filter field to search paths or summaries.

Use the Servers dropdown at the top of the spec for Sandbox or Production. Use that same base URL (scheme + host, no trailing slash clutter) in your integration. Sandbox is for non‑production testing; production is for live data—match the server to the credentials and tenant you were given.

Guidance for integration

• Requests: send JSON bodies with Content-Type: application/json unless an operation documents otherwise. Respect required fields, formats (for example UUIDs and dates), and enums shown in each operation.
• Auth: after login or token exchange, pass the token as Authorization: Bearer <token>. Refresh or re-authenticate when you receive 401 from the API.
• Errors: on failure, read the response body and HTTP status (validation and client errors are usually 4xx; unexpected server issues 5xx). The spec lists common responses per operation—use them when handling errors in code.
• Calling from your app: server-side or mobile clients call the API directly over HTTPS without going through this page. Browser Try it out only works if the API allows this site’s origin (CORS); your own domain must be allowed for front-end calls.
• Security: keep client secrets and tokens out of source control; use environment variables or a secret store. Do not expose production tokens in screenshots or shared links.