Get a contact

GET/v1/contacts/{identifier}

Returns a single contact by ULID, email address, or E.164 phone number. Email addresses in the path must be URL-encoded. Blocked contacts can be retrieved by this endpoint.

Path Parameters

identifierstring required

Contact ULID, email address, or E.164 phone number. Email addresses in paths should be URL-encoded (%40 for @).

Example:ulid: 01kptye62pxs8pp0xkh6d5vxz2email: [email protected]encodedEmail: encoded%40example.comphone: +201288899999

Responses

Body

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

Example:200

messagestring required

Example:OK

detailsobject required

dataobject (GeneralContact)•Contact resource returned by list, show, and update. 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

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/{identifier}" \
  --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

{
  "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": {}
}