> ## Documentation Index
> Fetch the complete documentation index at: https://docs.conduit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Conduit API

> Programmatic access to your Conduit workspace data.

<Warning>
  The Conduit API is only available on the **v3 plan**. Contact [support@conduit.ai](mailto:support@conduit.ai) to enable API access for your workspace.
</Warning>

## 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 URL**

```
https://api.conduit.ai/v1
```

## Authentication

All requests require a **Bearer token** in the `Authorization` header. Generate API tokens from **Workspace menu > API** (click your workspace name in the top-left of the sidebar).

```bash theme={null}
curl https://api.conduit.ai/v1/workspaces \
  -H "Authorization: Bearer YOUR_API_TOKEN"
```

Tokens are scoped to one or more workspaces. Use the [List Workspaces](/api-reference/workspaces/list) endpoint to discover which workspaces your token can access.

## Pagination

List endpoints return paginated results. Use `limit` (1-100, default 20) and `cursor` to page through results.

```json theme={null}
{
  "data": [...],
  "next_cursor": "page-token",
  "has_more": true
}
```

Pass `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

By default, API requests are limited to **120 requests per minute per workspace**. If you exceed the limit, the API returns `429 Too Many Requests` with a `Retry-After` header indicating when you can retry. Some workspaces may have higher limits based on plan or entitlement.

See [Rate Limits](/rate-limits) for details.

## Errors

All errors return a JSON object with an `error` field:

```json theme={null}
{
  "error": "Invalid workspace id"
}
```

| 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                                   |