Skip to main content
GET
/
campaigns
/
by-id
/
{id}
cURL
curl --request GET \
  --url https://api.callab.ai/v1/campaigns/by-id/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "notes": "<string>",
    "status": "<string>",
    "campaign_type": "<string>",
    "call_progress": 123,
    "days_of_week": [
      4
    ],
    "time_zone": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "workspace": "<string>",
    "contacts_list_source": [
      "<string>"
    ],
    "contacts_list_tags": [
      "<string>"
    ],
    "contacts_list_categories": [
      "<string>"
    ],
    "contacts_list_source_metadata": {},
    "agent_variables_contact_metadata_mapping": {},
    "call_time_of_day_from": "<string>",
    "call_time_of_day_to": "<string>",
    "number_of_call_attempts": [
      123
    ],
    "retry_delay": [
      123
    ],
    "retry_delay_unit": [
      "<string>"
    ],
    "deleted_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-12-25",
    "ended_at": "2023-12-25",
    "webhook_mapping_variables": {},
    "webhook_mapping_variables_sources": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

ID of campaign to fetch

Response

Campaign response

​
status
string
required

Status of the response, e.g., 'ok' or 'error'

​
message
string
required

A descriptive message for the response

​
data

The data payload, which can be the campaign object or an error string.