Skip to main content
GET
/
api
/
v1
/
devices
List Devices
curl --request GET \
  --url https://api.example.com/api/v1/devices
{
  "devices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "session_name": "<string>",
      "status": "<string>",
      "is_primary": 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
}

Documentation Index

Fetch the complete documentation index at: https://docs.wazzapi.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string | null

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0
​
status
string | null

Optional device status filter, such as connected, disconnected, or pairing.

​
search
string | null

Filter by device name, session name, or phone number.

​
sort_by
string
default:created_at

Sort field: created_at, updated_at, name, status, or last_connected_at.

​
sort_order
string
default:desc

Sort direction: asc or desc.

Response

Successful Response

Paginated response for listing devices.

​
devices
DeviceItem · object[]
required
​
total
integer
required
​
limit
integer
required
​
offset
integer
required