Retrieves detailed information about a specific contact using various types of identifiers.
This is the primary way to fetch a single contact's complete profile.

How to Identify a Contact

You can retrieve a contact using any of these identifier formats in the URL path:

1. Customerly Contact ID (numeric):

• The internal numeric ID assigned by Customerly
• Example: GET /contacts/29911301

2. Custom User ID (prefix: cuid:):

• Your own custom identifier for a registered user
• Example: GET /contacts/cuid:user_123
• Use this if you've set a custom_contact_id when creating a user

3. Custom Lead ID (prefix: clid:):

• Your own custom identifier for a lead
• Example: GET /contacts/clid:lead_456
• Use this if you've set a custom_contact_id when creating a lead

4. WhatsApp Number (prefix: wa:):

• The contact's WhatsApp number in E.164 format
• Example: GET /contacts/wa:+1234567890
• Must include country code with + prefix

5. Email Address (prefix: uem: or lem:):

• For registered users: uem:[email protected] (User EMail)
• For leads: lem:[email protected] (Lead EMail)
• You must know whether the email belongs to a user or lead

Response Data

Always included in the response:

• Basic contact info: name, email, phone, creation date, last seen, etc.
• Custom attributes: All custom fields you've set for this contact
• Tags: All tags assigned to this contact

Optional data (use include parameter):
You can request additional related data by adding an include query parameter:

• events: Event statistics (what events they've triggered, when, how many times)
• companies: Associated companies and their attributes
• segments: Which segments this contact belongs to

How to use include:

• Single: ?include=events
• Multiple: ?include=events,companies,segments

Example Requests

# Get contact by Customerly ID with events and companies
GET /contacts/29911301?include=events,companies

# Get user by custom user ID with all optional data
GET /contacts/cuid:user_abc123?include=events,companies,segments

# Get lead by custom lead ID
GET /contacts/clid:lead_xyz789?include=companies

# Get contact by WhatsApp number (basic data only)
GET /contacts/wa:+1234567890

# Get user by email with segments
GET /contacts/uem:[email protected]?include=segments