List Devices
curl --request GET \
--url https://api.example.com/api/v1/devicesimport requests
url = "https://api.example.com/api/v1/devices"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/devices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"devices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"session_name": "<string>",
"status": "<string>",
"is_primary": true,
"message_logging_enabled": true,
"auto_warmer_enabled": true,
"total_messages_sent": 123,
"total_messages_received": 123,
"contacts_synced_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"phone_number": "<string>",
"last_connected_at": "2023-11-07T05:31:56Z",
"last_health_check_at": "2023-11-07T05:31:56Z",
"last_contact_sync_at": "2023-11-07T05:31:56Z",
"last_contact_sync_status": "<string>"
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}devices
List Devices
List WhatsApp devices available to the authenticated organization.
Requires admin:read or higher because device inventory exposes
operational metadata for the workspace.
GET
/
api
/
v1
/
devices
List Devices
curl --request GET \
--url https://api.example.com/api/v1/devicesimport requests
url = "https://api.example.com/api/v1/devices"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/devices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"devices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"session_name": "<string>",
"status": "<string>",
"is_primary": true,
"message_logging_enabled": true,
"auto_warmer_enabled": true,
"total_messages_sent": 123,
"total_messages_received": 123,
"contacts_synced_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"phone_number": "<string>",
"last_connected_at": "2023-11-07T05:31:56Z",
"last_health_check_at": "2023-11-07T05:31:56Z",
"last_contact_sync_at": "2023-11-07T05:31:56Z",
"last_contact_sync_status": "<string>"
}
],
"total": 123,
"limit": 123,
"offset": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Query Parameters
Required range:
1 <= x <= 100Required range:
x >= 0Optional device status filter, such as connected, disconnected, or pairing.
Filter by device name, session name, or phone number.
Sort field: created_at, updated_at, name, status, or last_connected_at.
Sort direction: asc or desc.