API Documentation
Endpoint Examples
Phone Numbers
Campaigns
Webhooks
Get All Campaigns
Returns all campaigns from the system that the user has access to
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The maximum number of results to return
Response
ok, error The name of the campaign
The current status of the campaign
active, paused, completed Additional notes or description for the campaign
The ID of the company associated with the campaign
The ID of the user who owns the campaign
The type of campaign
outbound, inbound Sources of the contacts list
Tags associated with the contacts list
Categories associated with the contacts list
Metadata about the contacts list sources
Mapping of agent variables to contact metadata
The ID of the AI agent associated with the campaign
The progress of the campaign
The start time for calls
The end time for calls
Number of call attempts for each contact
Delay between retry attempts
Unit of the retry delay
Days of the week when the campaign is active
The time zone for the campaign
The ID of the inbound phone number
The ID of the outbound phone number
Whether non-local calls are allowed
Timestamp when the campaign was created
Timestamp when the campaign was last updated
Timestamp when the campaign was deleted
The start date of the campaign
The end date of the campaign
Variables for webhook mappings
Sources for webhook mapping variables
The ID of the webhook associated with the campaign
Was this page helpful?
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"
}
]
}