Get an specific contact

Gets a Contact by Id.

GET /api/contact/{id}

Get Contact

cURL

curl --request GET \
  --url https://api.hilos.io/api/contact/{id} \
  --header 'Authorization: <api-key>'

200

{
  "canonical_phone": "<string>",
  "created_by": 123,
  "phone": "<string>",
  "id": "<string>",
  "last_updated_on": "2023-11-07T05:31:56Z",
  "source": "<string>",
  "notes": [
    {
      "id": 123,
      "notes": "<string>",
      "contact": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_on": "2023-11-07T05:31:56Z",
      "created_by": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "[e-mail]",
        "profile_image": "<string>",
        "role": "AGENT"
      }
    }
  ],
  "tags": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "default_assignees": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[e-mail]",
      "account": 123,
      "profile_image": "<string>",
      "date_joined": "2023-11-07T05:31:56Z"
    }
  ],
  "inbox_contacts": [
    {
      "url": "<string>",
      "channel": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "default_conversation_url": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[e-mail]",
  "meta": {},
  "external_url": "<string>",
  "is_deleted": true,
  "created_on": "2023-11-07T05:31:56Z",
  "contact_import": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "default_channel": 123
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

id · string<uuid> · required

Response

200 - application/json

canonical_phone · string · required

Maximum string length: 30

created_by · integer · required

User ID of the user who created the contact

phone · string · required

Phone number of the contact

id · string · required

UUID representing the contact ID

last_updated_on · string<date-time> · required

source · string · required

Maximum string length: 255

notes · object[] · required

Notes associated with the contact

Show child attributes

tags · object[] · required

Tags associated with the contact

Show child attributes

default_assignees · object[] · required

ID of the default assignees for the contact

Show child attributes

inbox_contacts · object[] · required

URL of the inbox conversation associated with the contact

Show child attributes

default_conversation_url · string · required

first_name · string | null

Maximum string length: 100

last_name · string | null

Maximum string length: 100

email · string<email> | null

Maximum string length: 254

meta · object

Show child attributes

external_url · string<uri> | null

Maximum string length: 200

is_deleted · boolean

created_on · string<date-time>

contact_import · string<uuid> | null

default_channel · integer | null