Get a contact

GET

/contact/{identifier}

curl --request GET \
  --url https://api.aelyst.ai/v1/contact/example \
  --header 'Authorization: Bearer <token>'

• Production

Retrieves the information of an existing contact.

Authorizations

• BearerAuth

Parameters

Path Parameters

identifier

required

string

Identifier of the contact that can either be a phone number, email or contact ID. Examples: id:123 , email:abdc@gmail.com , phone:+60121233112

Responses

200

Media typeapplication/json

object

id

Contact ID

integer

Any of:

object

object

firstName

required

string

lastName

string

nullable

phone

string

nullable

email

string

nullable

language

Following the ISO 639-1 standard.

string

nullable

profilePic

string

nullable

countryCode

Following the ISO 3166-1 alpha-2 standard.

string

nullable

custom_fields

Array<object>

nullable

object

name

required

string

value

Formatting rules

• Text: “string” (use quotation marks for the string value)
• Number: Number (without any quotation marks)
• Email: “email” (format: user@domain.com)
• URL: “url” (format: www.website.com, https://www.website.com, website.com, http://website.com)
• List: “string” (the string value must match one of the list options)
• Date: “yyyy-mm-dd” (must follow this format)
• Time: “HH:MM” (must follow 24H format, 1PM => 13:00)
• Checkbox: “true/false” (must be true for checked, false for unchecked)

string

nullable

status

Conversation status of the contact

string

Allowed values: open closed blocked

tags

Array<string>

<= 10 items unique items

assignee

User

User to whom the contact is assigned

object

id

required

User ID

integer

firstName

required

string

lastName

required

string

email

required

string format: email

lifecycle

string

nullable

created_at

Unix timestamp in seconds representing when the contact was created.

integer

isBlocked

boolean

Example

{
  "id": 12345,
  "firstName": "Muhammad ",
  "lastName": "Mahin",
  "phone": "+60123456789",
  "email": "test@example.com",
  "language": "ms",
  "profilePic": "https://cdn.aelyst.ai/profile_avatar.png",
  "countryCode": "MY",
  "custom_fields": [
    {
      "name": "Company Website",
      "value": "https://example.com"
    }
  ],
  "status": "open",
  "tags": [
    "new_customer, sales"
  ],
  "assignee": {
    "id": 12345,
    "firstName": "Muhammad Mahin",
    "lastName": "Dar",
    "email": "test@example.com"
  },
  "lifecycle": "Hot Lead",
  "created_at": 1663274081
}

400

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Validation error."
}

401

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

404

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 404,
  "message": "Contact not found"
}

429

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Retry-After

number

Example

1

Number of seconds until you can retry the request

X-RateLimit-Limit

number

Example

10

Number of request allowed for this end point

X-RateLimit-Remaining

number

Example

5

Number of request remaining for this end point

500

Media typeapplication/json

object

code

integer

message

string

Example

{
  "code": 500,
  "message": "Unexpected error occurred"
}