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

# Introduction

> The campaign, contact and sequence endpoints of the Deliveryman API

Version 1 of the Deliveryman API drives the dashboard's campaign features from your own code: campaigns, contact
lists, leads, email sequences and replies.

> [!NOTE]
>
> V1 is in maintenance. It keeps working and existing integrations don't need to change, but new features only go
> into V2. If you're starting a new integration, use [V2](https://docs.deliveryman.ai/introduction.md) instead.

V2 covers sending, replies, verification, suppression and webhooks. It doesn't replace the campaign endpoints on
this page, so keep using V1 for those.

## Base URL

```http theme={null}
https://api.deliveryman.ai/api/v1/
```

## Authentication

V1 and V2 share the same API keys. Send yours in the `X-Api-Key` header. To create a key, go to **Integrations** in
the dashboard, open **Deliveryman API Keys** and click **Manage**.

```bash theme={null}
curl "https://api.deliveryman.ai/api/v1/workspaces/" \
  -H "X-Api-Key: YOUR_API_KEY"
```

## Workspaces

Most V1 endpoints act on one workspace. Call [List all Workspaces](https://docs.deliveryman.ai/api-reference-v1/workspaces/list-all-workspaces.md)
first to get the `workspace_id` values your key can reach, then pass the one you want as a query parameter.

## Pagination

List endpoints take `limit` and `offset` query parameters and return `data` alongside a `total` count.

## Errors

V1 uses standard HTTP status codes. Error responses have a `message` field describing what went wrong.

| Status | Meaning |
| - | - |
| `400` | The request is invalid. Check `message` for the field that failed. |
| `403` | The API key is missing or invalid. |
| `404` | The workspace, campaign or record doesn't exist. |
| `5xx` | Something went wrong on our side. Retry later. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.