cURL
curl -sS -X GET "https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts" \
-H "Authorization: Bearer $ONDIAL_API_KEY"const res = await fetch("https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts", {
method: "GET",
headers: {
"Authorization": `Bearer ${process.env.ONDIAL_API_KEY}`,
},
});
const data = await res.json();
console.log(res.status, data);import os
import requests
res = requests.request(
"GET",
"https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts",
headers={
"Authorization": f"Bearer {os.environ['ONDIAL_API_KEY']}",
},
timeout=30,
)
print(res.status_code, res.json())<?php
$ch = curl_init("https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("ONDIAL_API_KEY"),
],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status . " " . $response;import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts"))
.header("Authorization", "Bearer " + System.getenv("ONDIAL_API_KEY"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System;
using System.Net.Http;
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts");
request.Headers.Add("Authorization", "Bearer " + Environment.GetEnvironmentVariable("ONDIAL_API_KEY"));
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode + " " + await response.Content.ReadAsStringAsync());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("ONDIAL_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(out))
}{
"contacts": [
{
"contactId": "<string>",
"campaignId": "<string>",
"phone": "<string>",
"status": "<string>",
"callReceiveStatus": 123,
"whatsappStatus": "<string>",
"whatsappQueueStatus": "<string>",
"emailStatus": "<string>",
"emailScheduledAt": "2023-11-07T05:31:56Z",
"whatsappScheduledAt": "2023-11-07T05:31:56Z",
"emailTemplateId": "<string>",
"emailProfileId": "<string>",
"whatsappTemplateId": "<string>",
"whatsappProfileId": "<string>",
"isFollowUp": true,
"scheduledAt": "2023-11-07T05:31:56Z",
"requestedChannels": [
"<string>"
],
"source": "<string>",
"sandbox": true,
"deletedAt": "2023-11-07T05:31:56Z",
"lastCall": {
"callId": "<string>",
"status": "<string>",
"hasAnalysis": true,
"startedAt": "2023-11-07T05:31:56Z"
}
}
],
"nextCursor": "<string>"
}{
"error": "Invalid or inactive API key",
"reasonCode": "unauthorized"
}{
"error": "Not found",
"reasonCode": "not_found"
}List campaign contacts
Paginated contacts for a campaign - not campaign CRUD.
GET
https://dashboard.ondial.ai
/
api
/
v1
/
campaigns
/
{campaignId}
/
contacts
cURL
curl -sS -X GET "https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts" \
-H "Authorization: Bearer $ONDIAL_API_KEY"const res = await fetch("https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts", {
method: "GET",
headers: {
"Authorization": `Bearer ${process.env.ONDIAL_API_KEY}`,
},
});
const data = await res.json();
console.log(res.status, data);import os
import requests
res = requests.request(
"GET",
"https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts",
headers={
"Authorization": f"Bearer {os.environ['ONDIAL_API_KEY']}",
},
timeout=30,
)
print(res.status_code, res.json())<?php
$ch = curl_init("https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts");
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("ONDIAL_API_KEY"),
],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status . " " . $response;import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts"))
.header("Authorization", "Bearer " + System.getenv("ONDIAL_API_KEY"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System;
using System.Net.Http;
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts");
request.Headers.Add("Authorization", "Bearer " + Environment.GetEnvironmentVariable("ONDIAL_API_KEY"));
var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode + " " + await response.Content.ReadAsStringAsync());package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, _ := http.NewRequest("GET", "https://dashboard.ondial.ai/api/v1/campaigns/YOUR_CAMPAIGN_ID/contacts", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("ONDIAL_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(out))
}{
"contacts": [
{
"contactId": "<string>",
"campaignId": "<string>",
"phone": "<string>",
"status": "<string>",
"callReceiveStatus": 123,
"whatsappStatus": "<string>",
"whatsappQueueStatus": "<string>",
"emailStatus": "<string>",
"emailScheduledAt": "2023-11-07T05:31:56Z",
"whatsappScheduledAt": "2023-11-07T05:31:56Z",
"emailTemplateId": "<string>",
"emailProfileId": "<string>",
"whatsappTemplateId": "<string>",
"whatsappProfileId": "<string>",
"isFollowUp": true,
"scheduledAt": "2023-11-07T05:31:56Z",
"requestedChannels": [
"<string>"
],
"source": "<string>",
"sandbox": true,
"deletedAt": "2023-11-07T05:31:56Z",
"lastCall": {
"callId": "<string>",
"status": "<string>",
"hasAnalysis": true,
"startedAt": "2023-11-07T05:31:56Z"
}
}
],
"nextCursor": "<string>"
}{
"error": "Invalid or inactive API key",
"reasonCode": "unauthorized"
}{
"error": "Not found",
"reasonCode": "not_found"
}There is no
POST /api/v1/campaigns. Create and start campaigns in the dashboard. Use List campaigns and Get campaign to look up campaignId and templates.Authorizations
Paste only your API key (ond_live_… or ond_test_…). Do not type the word Bearer - the playground adds it.
Path Parameters
Response
Page of contacts
Hide child attributes
Hide child attributes

