Skip to main content
Version 1 of the Deliveryman API drives the dashboard’s campaign features from your own code: campaigns, contact lists, leads, email sequences and replies.
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 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

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

​
Workspaces

Most V1 endpoints act on one workspace. Call List all Workspaces 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.