List campaigns
curl --request GET \
--url https://api-eg.olimi.ai/api/v2/campaigns \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api-eg.olimi.ai/api/v2/campaigns"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api-eg.olimi.ai/api/v2/campaigns', 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-eg.olimi.ai/api/v2/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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-eg.olimi.ai/api/v2/campaigns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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-eg.olimi.ai/api/v2/campaigns")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Campaigns fetched successfully",
"meta": {
"totalItems": 12,
"itemCount": 10,
"itemsPerPage": 10,
"totalPages": 2,
"currentPage": 1
},
"data": [
{
"id": "3e8b5d21-7c4a-4f96-a1d0-6b2e9c7f4a58",
"name": "September renewals",
"callType": "outbound",
"isActive": true,
"status": "in-progress",
"dials": 318,
"answered": 142,
"minutesUsed": 407,
"hasDidNumbers": false,
"agent": {
"id": "0d6a3f7e-5b8c-4b1e-9a51-2f1d7c9e4a10",
"name": "Renewals Agent"
},
"customerLists": [
{
"id": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"name": "September renewals"
}
],
"createdAt": "2026-09-28T10:15:02.418Z",
"updatedAt": "2026-09-28T10:15:02.418Z"
}
]
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 422,
"message": [
"name must be shorter than or equal to 100 characters"
],
"error": "Unprocessable Entity"
}Campaigns
List campaigns
Returns your campaigns, newest first, one page at a time, with progress counts for each.
GET
/
api
/
v2
/
campaigns
List campaigns
curl --request GET \
--url https://api-eg.olimi.ai/api/v2/campaigns \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api-eg.olimi.ai/api/v2/campaigns"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api-eg.olimi.ai/api/v2/campaigns', 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-eg.olimi.ai/api/v2/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$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-eg.olimi.ai/api/v2/campaigns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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-eg.olimi.ai/api/v2/campaigns")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-eg.olimi.ai/api/v2/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Campaigns fetched successfully",
"meta": {
"totalItems": 12,
"itemCount": 10,
"itemsPerPage": 10,
"totalPages": 2,
"currentPage": 1
},
"data": [
{
"id": "3e8b5d21-7c4a-4f96-a1d0-6b2e9c7f4a58",
"name": "September renewals",
"callType": "outbound",
"isActive": true,
"status": "in-progress",
"dials": 318,
"answered": 142,
"minutesUsed": 407,
"hasDidNumbers": false,
"agent": {
"id": "0d6a3f7e-5b8c-4b1e-9a51-2f1d7c9e4a10",
"name": "Renewals Agent"
},
"customerLists": [
{
"id": "9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24",
"name": "September renewals"
}
],
"createdAt": "2026-09-28T10:15:02.418Z",
"updatedAt": "2026-09-28T10:15:02.418Z"
}
]
}{
"statusCode": 404,
"errorCode": "agent_not_found",
"message": "Agent not found"
}{
"statusCode": 422,
"message": [
"name must be shorter than or equal to 100 characters"
],
"error": "Unprocessable Entity"
}Each campaign comes with progress counts. See Progress fields and Status values.
The list doesn’t include the schedule and retry settings. Use Get a campaign for those.
Use
meta.totalPages to know when you’ve fetched every page.Authorizations
Query Parameters
Page number, starting at 1.
Required range:
x >= 1Campaigns per page.
Required range:
x >= 1Matches campaigns whose name contains the text. Not case-sensitive.
Only running campaigns (true) or only paused ones (false).
Only campaigns that use this agent.
Only campaigns that call this customer list.