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

Authorizations

Authorization
string
header
required

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

Query Parameters

q
string
required

Search query

limit
integer
default:10

Maximum results (1-50, default 10)

Required range: 1 <= x <= 50

Response

Search results

items
object[]