Contacts

Get Contact details by Id.

get/contacts/{id}

Request

  • Base URL: https://api.charla.com/v1
  • URL: https://api.charla.com/v1/contacts/{id}
  • Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

The Contat Id to retrieve.

Response

OK

idstring uuid nullable

Unique id of the contact

namestring nullable

Name of the visitor if available

phonestring nullable

Phone of the visitor if available

emailstring nullable

Email of the visitor if available

country_codestring nullable

Country code in ISO 3166-1

locationstring nullable

Location per IP address

ipstring nullable

IP address of the visitor

platformstring nullable

Device used by the visitor

browser_languagestring nullable

Browser language used by the visitor

tagsstring nullable

Tags to Attach to the visitor. Accepts one or multiple comma seperated tags. Note that the tag needs to be already added on the organization.

last_seen_atstring date-time nullable

Date where the visitor was last seen, either with or without an interaction

last_message_atstring date-time nullable
created_atstring date-time nullable

Date where the visitor was initially created

Example response

{
  "id": "a9b259f5-3c3c-471e-86c7-3e69b3d83d25",
  "name": "Adam",
  "phone": "+201223461740",
  "email": "hello@site.com",
  "country_code": "US",
  "location": "Miami, Florida",
  "ip": "82.48.123.43",
  "platform": "iPhone, iOS",
  "browser_language": "en-US",
  "tags": "lead, hot",
  "custom_attributes": [
    {
      "name": "Company",
      "value": "Charla",
      "external_id": "company-39415"
    }
  ],
  "messages": [
    {
      "message": "Hello there",
      "message_translated": "Hola",
      "from": "Visitor",
      "article": 5
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.