API Documentation
Phone Numbers
Company Users
Campaigns
AI Agents
Webhooks
integrations
Campaigns
Get Campaigns By Workspace
Returns all campaigns for a given workspace.
GET
/
campaigns
/
by-workspace
/
{workspace}
Copy
Ask AI
curl --request GET \
--url https://api.callab.ai/v1/campaigns/by-workspace/{workspace} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"status": "ok",
"message": "<string>",
"data": [
{
"name": "<string>",
"notes": "<string>",
"status": "<string>",
"campaign_type": "<string>",
"contacts_list_source": [
"<string>"
],
"contacts_list_tags": [
"<string>"
],
"contacts_list_categories": [
"<string>"
],
"contacts_list_source_metadata": {},
"agent_variables_contact_metadata_mapping": {},
"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>",
"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": {},
"workspace": "<string>"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Workspace slug to fetch campaigns for.
Response
200
application/json
An array of campaigns
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request GET \
--url https://api.callab.ai/v1/campaigns/by-workspace/{workspace} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"status": "ok",
"message": "<string>",
"data": [
{
"name": "<string>",
"notes": "<string>",
"status": "<string>",
"campaign_type": "<string>",
"contacts_list_source": [
"<string>"
],
"contacts_list_tags": [
"<string>"
],
"contacts_list_categories": [
"<string>"
],
"contacts_list_source_metadata": {},
"agent_variables_contact_metadata_mapping": {},
"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>",
"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": {},
"workspace": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.