Skip to main content
GET
List campaigns

Authorizations

Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Query Parameters

page_size
integer

Number of records per page (default 50, max 100).

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

Opaque pagination cursor returned by the previous response.

status
enum<string>
Available options:
Running,
Scheduled,
Stopped,
Completed,
Failed,
Expired,
Paused
created_after
string<date-time>

Filter records created on or after this ISO 8601 timestamp.

created_before
string<date-time>

Filter records created on or before this ISO 8601 timestamp.

Response

Paginated list of campaigns.

has_more
boolean
required

Whether more records exist after this page.

campaigns
object[]
required
next_cursor
string

Opaque cursor to pass as cursor in the next request.