Skip to main content
GET
/
v1
/
campaigns
List campaigns
curl --request GET \
  --url https://api.openmic.ai/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "type": "outbound",
      "status": "Scheduled",
      "bot_uid": "<string>",
      "from_number": "<string>",
      "contact_list_id": 123,
      "time_start": "<string>",
      "time_end": "<string>",
      "timezone": "<string>",
      "days": [
        "Monday"
      ],
      "schedule_type": "single",
      "current_index": 123,
      "total_contacts": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Authorization: Bearer <your-api-key>

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
status
enum<string>

Filter by campaign status.

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

Response

200 - application/json

List of campaigns

campaigns
object[]
pagination
object