GET
/
campaign
/
list
curl --request GET \
  --url http://sandbox.mintlify.com/campaign/list \
  --header 'Authorization: Bearer <token>'
{
  "status": "ok",
  "message": "<string>",
  "data": [
    {
      "name": "<string>",
      "notes": "<string>",
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "campaign_type": "outbound",
      "contacts_list_source": [
        "<string>"
      ],
      "contacts_list_tags": [
        [
          "<string>"
        ]
      ],
      "contacts_list_categories": [
        [
          "<string>"
        ]
      ],
      "contacts_list_source_metadata": {},
      "agent_variables_contact_metadata_mapping": {},
      "ai_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "call_progress": 123,
      "call_time_of_day_from": "<string>",
      "call_time_of_day_to": "<string>",
      "number_of_call_attempts": [
        123
      ],
      "retry_delay": [
        123
      ],
      "retry_delay_unit": [
        "<string>"
      ],
      "days_of_week": [
        4
      ],
      "time_zone": "<string>",
      "inbound_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "outbound_phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "allow_non_local_calls": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-12-25",
      "ended_at": "2023-12-25",
      "webhook_mapping_variables": {},
      "webhook_mapping_variables_sources": {},
      "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

The maximum number of results to return

Response

200 - application/json

Campaign response

The response is of type object.