List Contacts

GET/v1/contacts

Returns both blocked and non-blocked contacts, ordered by created_at descending. Empty results return 200 with data: [] and meta.total: 0.

Query Parameters

pageinteger

Example:1

per_pageinteger

Example:25

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

idstring•Contact ULID

avatarstring or null•Public URL to avatar image

full_namestring

emailstring or null

phone_numberstring

company_namestring or null

country_namestring or null

city_namestring or null

biostring or null

sourceenum: api | client | crm | import

typeenum: internal | external

additional_attributesobject

tagsarray[object]

idstring•Tag ULID

namestring

colorstring or null

descriptionstring or null

custom_attributesarray[object]

idstring•Custom attribute ULID

display_namestring

keystring

typestring

valuestring or null

notesarray[object]

idstring•Note ULID

contentstring

created_bystring•Agent UUID

created_atstring (date-time)

updated_atstring (date-time)

is_blockedboolean

created_atstring (date-time)

updated_atstring (date-time)

metaobject (GeneralPaginationMeta) required

current_pageinteger required

per_pageinteger required

totalinteger required

last_pageinteger required

linksobject required

firststring required

laststring required

prevstring or null required

nextstring or null required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/contacts?page=1&per_page=25" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "id": "string",
      "avatar": "string",
      "full_name": "string",
      "email": "string",
      "phone_number": "string",
      "company_name": "string",
      "country_name": "string",
      "city_name": "string",
      "bio": "string",
      "source": "api",
      "type": "internal",
      "additional_attributes": {},
      "tags": [
        {
          "id": "string",
          "name": "string",
          "color": "string",
          "description": "string"
        }
      ],
      "custom_attributes": [
        {
          "id": "string",
          "display_name": "string",
          "key": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "notes": [
        {
          "id": "string",
          "content": "string",
          "created_by": "string",
          "created_at": "2024-01-01T12:00:00Z",
          "updated_at": "2024-01-01T12:00:00Z"
        }
      ],
      "is_blocked": true,
      "created_at": "2024-01-01T12:00:00Z",
      "updated_at": "2024-01-01T12:00:00Z"
    }
  ],
  "meta": {
    "current_page": 0,
    "per_page": 0,
    "total": 0,
    "last_page": 0,
    "links": {
      "first": "string",
      "last": "string",
      "prev": "string",
      "next": "string"
    }
  }
}