Skip to main content
GET
List Outbound Campaigns
List the outbound campaigns under a project, newest created first. Use it to find the campaign you want to pull dispatches for. Read-only.

Request

Headers

string
required
Bearer token authentication with your Developer Key (dk_...).

Query parameters

string
required
The project whose campaigns to list. The Developer Key must have access to it.
string
Filter by campaign status, comma-separated (e.g. active,completed). An unrecognized value returns 400 rather than silently matching nothing.
integer
Campaigns to return. Defaults to 20, capped at 100. For just the latest campaign, pass limit=1.

Example

Response

array

Example

Errors

Notes

  • Ordering: by created_at, newest first — not by updated_at. The scheduler rewrites a campaign throughout a run, so ordering by last update would let an older campaign that is still dialing outrank one created today.
  • Deciding what to pull: compare completed_contacts against total_contacts to tell whether a campaign has finished before fetching its dispatches.
  • No pagination: campaigns per project run to the tens, so limit alone covers it. There is no cursor.
  • Scope: only campaigns under projects the Developer Key can access. There is no cross-project listing.