Get All Campaigns

curl --request GET \
  --url https://api.getmalakai.com/campaigns/outbound \
  --header 'Authorization: <authorization>' \
  --header 'x-access-token: <x-access-token>'

import requests

url = "https://api.getmalakai.com/campaigns/outbound"

headers = {
    "Authorization": "<authorization>",
    "x-access-token": "<x-access-token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'x-access-token': '<x-access-token>'}
};

fetch('https://api.getmalakai.com/campaigns/outbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmalakai.com/campaigns/outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "x-access-token: <x-access-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmalakai.com/campaigns/outbound"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("x-access-token", "<x-access-token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getmalakai.com/campaigns/outbound")
  .header("Authorization", "<authorization>")
  .header("x-access-token", "<x-access-token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmalakai.com/campaigns/outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["x-access-token"] = '<x-access-token>'

response = http.request(request)
puts response.read_body

{
    "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
            }
        ]
    }
}

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>'

import requests

url = "https://api.getmalakai.com/campaigns/outbound"

headers = {
    "Authorization": "<authorization>",
    "x-access-token": "<x-access-token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'x-access-token': '<x-access-token>'}
};

fetch('https://api.getmalakai.com/campaigns/outbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmalakai.com/campaigns/outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "x-access-token: <x-access-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmalakai.com/campaigns/outbound"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("x-access-token", "<x-access-token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getmalakai.com/campaigns/outbound")
  .header("Authorization", "<authorization>")
  .header("x-access-token", "<x-access-token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmalakai.com/campaigns/outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["x-access-token"] = '<x-access-token>'

response = http.request(request)
puts response.read_body

{
    "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

string

required

Your API key for authentication. Prefix with Bearer .

string

required

Your access token for authentication.

Response

object

An object containing all campaigns details.

object

AN object containing the overall analytics of all the outbound campaigns related to the specific user

string

Total number of contacts involved in the campaign

string

The total number of calls made for th entire campaign

string

Percantage representing the completion of calls involved in a campaign

object[]

An array of objects containing details regarding a specific campaign

string

A specific identifier for a campaign

string

The user identifier associated with the campaign

string

The name of the campaign

number

Maximum allowed duration for the campaign (in seconds)

string

The identifier for the agent attached with this campaign

string

Voicemail configuration or content (null if not set)

object

A map of transfer numbers for call routing (empty if not defined)

object

Webhooks configured for the campaign (null if not set)

boolean

Indicates if the campaign is a draft

string

Associated Identifier for the machine learning side

string

Current status of the campaign (e.g., completed, failed)

string

Internal state of the campaign (e.g., running, stopped)

string

AI model used in the campaign (e.g., Claude 3 Haiku)

object

Contains schema analysis data if available (null if not set)

string

Timestamp of campaign creation (ISO format)

string

Timestamp of last update to the campaign (ISO format)

string

Identifier for the associated workflow (null if not set)

number

Total number of contacts included in the campaign

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
            }
        ]
    }
}

Agents

Contacts

Callers

Voices

Knowledge Bases

Workflows

Campaigns

Get All Campaigns

Headers

Response

​Headers

​Response

Headers

Response