API ReferenceCampaigns
List your campaigns
Your campaigns, newest first.
The response is { nodes, totalCount }. Filter by ids, types, statuses, a from/to range on the start date, or search on the name. Page through with first (up to 500) and skip. Codes like status: 10 are explained by the glossary.
Authorization
ClientBearer AuthorizationBearer <token>
Client-scoped key as a Bearer JWT; always pinned to your own client.
In: header
Query Parameters
statuses?string
Campaign status codes (0=DRAFT,10=ACTIVE,15=COMPLETED,20=ARCHIVED). status also works.
types?string
Campaign type codes (1=HANDTOHAND,2=LETTERBOX,3=DIRECTMAIL,4=INSERTS). type also works.
search?string
Search by campaign name.
first?string
Page size 1..500 (default 50).
skip?string
Page offset (default 0).
Response Body
application/json
curl -X GET "https://example.com/client/campaigns"{ "success": true, "data": { "nodes": [ { "id": "9114", "name": "Spring H2H — Chicago", "type": 1, "status": 10, "client_id": "4101", "country_id": "14", "country_name": "United States", "start_date": "2026-03-02", "campaign_duration_week": 13, "offer_expiration_date": "2026-07-01", "no_expiration": false, "scan_data_enabled": true, "conversions_api_enabled": true, "created_at": "2026-01-14T09:22:31.000Z", "updated_at": "2026-06-20T11:05:02.000Z", "typeEnum": "HANDTOHAND", "statusEnum": "ACTIVE" } ], "totalCount": 1 }}Empty
Empty
Empty
Empty
Empty