Skip to main content
GET
List Campaigns

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Query Parameters

status
enum<string>

Only campaigns in this state. A scheduled campaign is a draft with scheduledAt set until it starts.

Available options:
draft,
sending,
paused,
sent,
failed,
cancelled
limit
integer
default:25

How many items to return, 1 to 100.

Required range: 1 <= x <= 100
cursor
string

The nextCursor from the previous page. Leave it out for the first page.

Response

One page of campaigns, newest first.

items
object[]
required

Campaigns, newest first.

nextCursor
string | null
required

Pass as cursor for the next page. null on the last page.