Skip to main content
GET
campaigns
/
outbound
Get All Campaigns
curl --request GET \
  --url https://api.getmalakai.com/campaigns/outbound \
  --header 'Authorization: <authorization>' \
  --header 'x-access-token: <x-access-token>'
{
    "responseCode": 2000,
    "message": "Compaigns fetched successfully",
    "data": {
        "analytics": {
            "Total Contacts": 42,
            "Total Calls Made": 24,
            "% of Completion": 57.14285714285714
        },
        "campaigns": [
            {
                "id": "***",
                "user_id": "***",
                "campaign_name": "Start",
                "max_duration": 300,
                "agent_id": "***",
                "voice_mail": null,
                "transfer_numbers": {},
                "dynamic_data": null,
                "webhooks": null,
                "is_draft": false,
                "ml_campaign_id": "***",
                "status": "completed",
                "state": "stopped",
                "model": "Claude 3 Haiku",
                "schema_analysis": null,
                "created_at": "***",
                "updated_at": "***",
                "workflow_id": null,
                "total_contacts": 3,
                "completion_percentage": 33.33333333333333
            }
        ]
    }
}

​
Headers

​
Authorization
string
required
Your API key for authentication. Prefix with Bearer .
​
x-access-token
string
required
Your access token for authentication.

​
Response

​
data
object
An object containing all campaigns details.
​
data.analytics
object
AN object containing the overall analytics of all the outbound campaigns related to the specific user
​
data.analytics.Total Contacts
string
Total number of contacts involved in the campaign
​
data.analytics.Total Calls Made
string
The total number of calls made for th entire campaign
​
data.analytics.% of Completion
string
Percantage representing the completion of calls involved in a campaign
​
campaigns
object[]
An array of objects containing details regarding a specific campaign
​
campaigns.id
string
A specific identifier for a campaign
​
campaigns.user_id
string
The user identifier associated with the campaign
​
campaigns.campaign_name
string
The name of the campaign
​
campaigns.max_duration
number
Maximum allowed duration for the campaign (in seconds)
​
campaigns.agent_id
string
The identifier for the agent attached with this campaign
​
campaigns.voice_mail
string
Voicemail configuration or content (null if not set)
​
campaigns.transfer_numbers
object
A map of transfer numbers for call routing (empty if not defined)
​
campaigns.webhooks
object
Webhooks configured for the campaign (null if not set)
​
campaigns.is_draft
boolean
Indicates if the campaign is a draft
​
campaigns.ml_campaign_id
string
Associated Identifier for the machine learning side
​
campaigns.status
string
Current status of the campaign (e.g., completed, failed)
​
campaigns.state
string
Internal state of the campaign (e.g., running, stopped)
​
campaigns.model
string
AI model used in the campaign (e.g., Claude 3 Haiku)
​
campaigns.schema_analysis
object
Contains schema analysis data if available (null if not set)
​
campaigns.created_at
string
Timestamp of campaign creation (ISO format)
​
campaigns.updated_at
string
Timestamp of last update to the campaign (ISO format)
​
campaigns.workflow_id
string
Identifier for the associated workflow (null if not set)
​
campaigns.total_contacts
number
Total number of contacts included in the campaign
​
campaigns.completion_percentage
number
Completion percentage of the campaign
{
    "responseCode": 2000,
    "message": "Compaigns fetched successfully",
    "data": {
        "analytics": {
            "Total Contacts": 42,
            "Total Calls Made": 24,
            "% of Completion": 57.14285714285714
        },
        "campaigns": [
            {
                "id": "***",
                "user_id": "***",
                "campaign_name": "Start",
                "max_duration": 300,
                "agent_id": "***",
                "voice_mail": null,
                "transfer_numbers": {},
                "dynamic_data": null,
                "webhooks": null,
                "is_draft": false,
                "ml_campaign_id": "***",
                "status": "completed",
                "state": "stopped",
                "model": "Claude 3 Haiku",
                "schema_analysis": null,
                "created_at": "***",
                "updated_at": "***",
                "workflow_id": null,
                "total_contacts": 3,
                "completion_percentage": 33.33333333333333
            }
        ]
    }
}