Skip to main content
GET
/
v1
/
contacts
List Contacts
curl --request GET \
  --url https://api.zavu.dev/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "con_abc123",
      "phoneNumber": "+56912345678",
      "countryCode": "CL",
      "availableChannels": ["sms", "whatsapp"],
      "defaultChannel": "whatsapp",
      "verified": true,
      "metadata": {
        "name": "John Doe",
        "customerId": "cus_123"
      },
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ],
  "nextCursor": null
}
Retrieve a list of contacts for your project.

Query Parameters

phoneNumber
string
Filter by phone number (exact match, E.164 format)
limit
integer
default:"50"
Number of items to return (max: 100)
cursor
string
Pagination cursor from previous response

Response

items
array
Array of contact objects
nextCursor
string
Cursor for the next page of results
{
  "items": [
    {
      "id": "con_abc123",
      "phoneNumber": "+56912345678",
      "countryCode": "CL",
      "availableChannels": ["sms", "whatsapp"],
      "defaultChannel": "whatsapp",
      "verified": true,
      "metadata": {
        "name": "John Doe",
        "customerId": "cus_123"
      },
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ],
  "nextCursor": null
}

Example

curl https://api.zavu.dev/v1/contacts \
  -H "Authorization: Bearer zv_live_xxx"

Filter by phone number

curl "https://api.zavu.dev/v1/contacts?phoneNumber=%2B56912345678" \
  -H "Authorization: Bearer zv_live_xxx"