Skip to main content

Base URL

All endpoints in this reference are prefixed with /api/v1/public/.

Authentication

Pass your API key in every request header:
See Authentication for how to generate keys.

Interactive playground

Every endpoint in this reference has a live Try it playground. Enter your API key in the authentication panel (top right) and make real API calls against your production workspace directly from the docs.
The playground uses your real production data. Use an sk_test_ key if you don’t want to affect live campaigns or leads.

Response conventions

Pagination

List endpoints support two pagination styles: Offset pagination (leads, campaigns, jobs):
Returns: { items, total, page, per_page } Cursor pagination (conversations):
Returns: { items, next_cursor }, next_cursor is null when there are no more pages.

Endpoint groups

The sidebar lists every endpoint under one of these 19 sections, in this order.