Skip to main content
GET
/
contacts
List contacts
curl --request GET \
  --url https://api.getarbol.com/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "givenName": "<string>",
      "familyName": "<string>",
      "displayName": "<string>",
      "primaryTelephone": "<string>",
      "primaryEmail": "<string>"
    }
  ],
  "total": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Query Parameters

limit
integer
default:50

Max items to return (1-100)

Required range: 1 <= x <= 100
offset
integer
default:0

Items to skip

Required range: x >= 0

Search contacts by name, phone, or email

Response

List of contacts

items
object[]
total
integer
hasMore
boolean
nextCursor
string | null