curl --request GET \
--url https://api.inbox.adraa.ai/api/v1/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.inbox.adraa.ai/api/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.inbox.adraa.ai/api/v1/contacts', 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.inbox.adraa.ai/api/v1/contacts",
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: Bearer <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.inbox.adraa.ai/api/v1/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <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.inbox.adraa.ai/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.inbox.adraa.ai/api/v1/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"contacts": [
{
"id": "cmbxgy7kq0002ph01u2v3w4x5",
"name": "Sara Al-Harbi",
"email": "[email protected]",
"phone": "+966501234567",
"countryIso": "SA",
"channels": [
"whatsapp",
"web"
],
"conversationId": "cmbxgz9pq0003ph01m4n5o6p7",
"conversationCount": 3,
"openCount": 1,
"lastActivityAt": "2026-06-12T10:30:00.000Z",
"assignedAgent": {
"id": "cmbxgwq1e0000ph01i0j1k2l3",
"nickname": "sara"
}
}
],
"total": 124,
"page": 1,
"pageSize": 20,
"totalPages": 7,
"facets": {
"countries": [
{
"code": "SA",
"count": 80
}
],
"channels": [
{
"platform": "whatsapp",
"count": 95
}
]
}
}{
"error": {
"code": "INVALID_API_TOKEN",
"message": "Invalid or revoked API token"
}
}List contacts
Lists everyone who has messaged the workspace, one row per contact, newest activity first. Mirrors the console’s Contacts page: the same search, country, channel, assignment, and open-conversation filters, plus facet counts for building filter UIs.
Contacts are created automatically when a customer first messages the workspace — they cannot be created or deleted through the API.
curl --request GET \
--url https://api.inbox.adraa.ai/api/v1/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.inbox.adraa.ai/api/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.inbox.adraa.ai/api/v1/contacts', 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.inbox.adraa.ai/api/v1/contacts",
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: Bearer <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.inbox.adraa.ai/api/v1/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <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.inbox.adraa.ai/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.inbox.adraa.ai/api/v1/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"contacts": [
{
"id": "cmbxgy7kq0002ph01u2v3w4x5",
"name": "Sara Al-Harbi",
"email": "[email protected]",
"phone": "+966501234567",
"countryIso": "SA",
"channels": [
"whatsapp",
"web"
],
"conversationId": "cmbxgz9pq0003ph01m4n5o6p7",
"conversationCount": 3,
"openCount": 1,
"lastActivityAt": "2026-06-12T10:30:00.000Z",
"assignedAgent": {
"id": "cmbxgwq1e0000ph01i0j1k2l3",
"nickname": "sara"
}
}
],
"total": 124,
"page": 1,
"pageSize": 20,
"totalPages": 7,
"facets": {
"countries": [
{
"code": "SA",
"count": 80
}
],
"channels": [
{
"platform": "whatsapp",
"count": 95
}
]
}
}{
"error": {
"code": "INVALID_API_TOKEN",
"message": "Invalid or revoked API token"
}
}Authorizations
Workspace API token created in Settings → API. Tokens start with adraa_.
Query Parameters
Matches against the contact's name, email, and phone.
160"sara"
ISO-3166 alpha-2 country code, derived from the contact's phone number. Use the facets.countries of an unfiltered request to see which codes are present.
2"SA"
Only contacts who have a conversation on this channel.
web, whatsapp, facebook, telegram, sms, email assigned — the contact's latest conversation has an agent; unassigned — it does not.
assigned, unassigned When true, only contacts with at least one open conversation.
1-based page number. Clamped to the last page when out of range.
x >= 1Contacts per page.
1 <= x <= 100activity (default) is the page-based, last-activity order. created switches to a lightweight, cursor-paginated, newest-first listing by the contact's first appearance in the workspace — for polling new contacts.
activity, created Used only with sort=created: the nextCursor from the previous page.
Used only with sort=created: page size (1–100).
1 <= x <= 100Response
One page of contacts plus facet counts