Overview
The Conduit API gives you programmatic access to contacts, conversations, tickets, calls, escalations, custom attributes, knowledge base, and workspace metadata. Read and write endpoints are available depending on your token’s access level. All endpoints are REST-based and return JSON. Base URLAuthentication
All requests require a Bearer token in theAuthorization header. Generate API tokens from Settings > API Tokens in your Conduit workspace.
Pagination
List endpoints return paginated results. Uselimit (1-100, default 20) and cursor to page through results.
next_cursor as the cursor query parameter in your next request to fetch the next page. When has_more is false, you’ve reached the end.
Rate Limits
API requests are rate-limited per workspace. If you exceed the limit, the API returns429 Too Many Requests with a Retry-After header indicating when you can retry.
Errors
All errors return a JSON object with anerror field:
| Status | Meaning |
|---|---|
| 400 | Invalid request parameters |
| 401 | Missing or invalid API token |
| 403 | Token does not have access to the requested workspace |
| 404 | Resource not found |
| 429 | Rate limit exceeded |