get
https://api.customerly.io/v2/contacts//events
Returns a paginated list of events that a contact has triggered. Events are statistical
records showing what actions a contact has performed, when they first and last occurred,
and how many times each event has happened.
Contact Identification
You can retrieve events using various types of identifiers:
1. Customerly Contact ID (numeric):
- Use the internal contact ID directly (e.g.,
29911301) - Example:
GET /contacts/29911301/events
2. Custom User ID (prefix: cuid:):
- Your own custom identifier for a registered user
- Example:
GET /contacts/cuid:user_123/events
3. Custom Lead ID (prefix: clid:):
- Your own custom identifier for a lead
- Example:
GET /contacts/clid:lead_456/events
4. WhatsApp Number (prefix: wa:):
- The contact's WhatsApp number in E.164 format
- Example:
GET /contacts/wa:+1234567890/events
5. Email Address (prefix: uem: or lem:):
- For registered users:
uem:[email protected](User EMail) - For leads:
lem:[email protected](Lead EMail) - Example:
GET /contacts/uem:[email protected]/events
Pagination
This endpoint uses cursor-based pagination:
per_page: Number of events to return per page (default: 20, max: 100)cursor: The cursor value from the previous response to fetch the next page
Example pagination flow:
- First request:
GET /contacts/{id}/events?per_page=20 - Response returns a
cursorvalue (e.g.,12345) and up to 20 events - Next page:
GET /contacts/{id}/events?per_page=20&cursor=12345 - Continue until
cursorisnull(no more events available)
Response
Events are ordered by last occurrence timestamp in descending order (most recent first).
Each event includes:
name: Event name (e.g., "page_viewed", "button_clicked")first: Unix timestamp of first occurrencelast: Unix timestamp of last occurrencecount: Total number of times the event occurred
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
401Authentication required
404Contact not found
422Invalid request parameters