Skip to main content
GET
/
h
/
v2
/
campaigns
List campaigns
curl --request GET \
  --url https://api.openmic.ai/h/v2/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "type": "outbound",
      "status": "Running",
      "agent_uid": "<string>",
      "from_number": "<string>",
      "contact_list_id": 123,
      "time_start": "09:00",
      "time_end": "17:00",
      "timezone": "America/New_York",
      "days": [
        "Monday"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}

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.