GET/v1/contacts

List contacts (paginated)

Returns non-blocked contacts in the workspace (`is_blocked = false`), ordered by `created_at` descending. Blocked contacts are excluded from the list but can still be retrieved by identifier via `GET /v1/contacts/{identifier}`. Empty workspace returns `200` with `data: []` and `meta.total: 0`. Private upstream path: `/v1/contacts`.

Parameters 2

Name	Type	Description
page	query · integer
per_page	query · integer

Bearer token required

Response examples

200OK

application/json example derived from schema

{
  "success_code": "OK",
  "message": "OK",
  "details": {},
  "data": [
    {
      "id": "string",
      "avatar": "string",
      "full_name": "string",
      "email": "string"
    }
  ],
  "meta": {
    "current_page": 0,
    "per_page": 0,
    "total": 0,
    "last_page": 0,
    "links": {
      "first": "string",
      "last": "string",
      "prev": "string",
      "next": "string"
    }
  }
}

400Bad Request

application/json example derived from schema

{
  "error_code": "VALIDATION_ERROR",
  "message": "string",
  "details": {}
}

Try ItBevatel Developer APIs v1.0.0

Code examples

curl -H 'Authorization: Bearer <TOKEN>' '/v1/contacts'

fetch("/v1/contacts", {
  method: "GET",
  headers: {
      "Authorization": "Bearer <TOKEN>"
    },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

import requests

url = "/v1/contacts"
headers = {
    "Authorization": "Bearer <TOKEN>"
}

response = requests.get(url, headers=headers)
print(response.json())

Authentication

Authentication

Bearer token

Paste cURL