List contacts - Arbol

GET

/

contacts

List contacts

curl --request GET \
  --url https://api.getarbol.com/v1/contacts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getarbol.com/v1/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2026-08-29T14:30:00Z",
      "familyName": "<string>",
      "givenName": "<string>",
      "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "lastAgentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "lastContactedAt": "2026-08-29T14:30:00Z",
      "primaryEmail": "<string>",
      "primaryPhone": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "total": 4503599627370495
}

{
  "defined": true,
  "inferable": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "<string>",
  "data": {
    "issues": [
      {
        "code": "custom",
        "message": "<string>",
        "path": [
          "<string>"
        ]
      }
    ],
    "truncated": true
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "<string>",
  "data": {
    "missingPermissions": [
      "agents:read"
    ]
  }
}

Authorizations

Authorization

string

header

required

Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.

Query Parameters

cursor

string

Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.

Required string length: 1 - 4096

limit

integer

default:25

Page size; defaults to 25 and never exceeds 100.

Required range: 1 <= x <= 100

createdAfter

string<date-time>

Only Contacts created at or after this instant.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-08-29T14:30:00Z"

createdBefore

string<date-time>

Only Contacts created before this instant; the bound is exclusive.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Example:

"2026-08-29T14:30:00Z"

order

enum<string>

default:desc

Direction used by an explicitly selected resource sort.

Available options:

asc,

desc

Example:

"desc"

query

string

Case-insensitive Contact search across names and tenant-owned identity addresses.

Required string length: 1 - 200

Example:

"Marta Rojas"

sort

enum<string>

default:createdAt

Stable sort field for Contact collection pages.

Available options:

createdAt,

name,

lastContactedAt

Example:

"createdAt"

Response

OK

One page of Contact summaries with the filtered total.

items

Contact summary · object[]

required

Maximum array length: 100

Show child attributes

nextCursor

string | null

required

Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.

Required string length: 1 - 4096

total

integer

required

Contacts matching the filters across every page.

Required range: 0 <= x <= 9007199254740991

List contacts

curl --request GET \
  --url https://api.getarbol.com/v1/contacts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getarbol.com/v1/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "createdAt": "2026-08-29T14:30:00Z",
      "familyName": "<string>",
      "givenName": "<string>",
      "id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "lastAgentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
      "lastContactedAt": "2026-08-29T14:30:00Z",
      "primaryEmail": "<string>",
      "primaryPhone": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "total": 4503599627370495
}

{
  "defined": true,
  "inferable": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "<string>",
  "data": {
    "issues": [
      {
        "code": "custom",
        "message": "<string>",
        "path": [
          "<string>"
        ]
      }
    ],
    "truncated": true
  }
}

{
  "defined": true,
  "inferable": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "<string>",
  "data": "<unknown>"
}

{
  "defined": true,
  "inferable": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "<string>",
  "data": {
    "missingPermissions": [
      "agents:read"
    ]
  }
}