Get information about all customer events
Get a list of customer events in the CareCloud platform.
Events represent customer interaction records and marketing automation triggers. They are used as conditions and triggers in CareCloud marketing automation workflows. This endpoint returns all events associated with the customer account.
Related: GET /events
Path parameters
The unique ID of the customer.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.
Direction of sorting the response list.
The unique ID of the event type. GET /event-types
The ID from other system than CareCloud. It is usually used for the synchronization or identification of the record in between CareCloud and other system. The ID doesn't need to be necessary unique. Usage of other parameter could be required to return more specific results.
List of the event type IDs from the resource GET /event-types. In case you want to filter multiple options use array syntax : event_type_ids[]=8bda8a4854394325e2748a5005&event_type_ids[]=9ceb9b5965405436f3859b6116 Logic OR is used between values.
If true, the property record structure will be included in the response. Possible values: true - property records structure will be included / false or not set - property records structure won't be included, and parameter will return null value
Start of the time interval for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.
End of the time interval for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"customer_events": [
{
"event_id": "82de12eb8b138791e678fd11c3",
"event_type_id": "8bda8a4854394325e2748a5005",
"customer_id": "8ea2591121e636086a4a9c0992",
"external_id": "157613",
"created_at": "2021-04-29 14:51:43",
"state": 1,
"property_records": [
{
"property_record_id": "docasna_blokace_darce_do:8ea2591121e636086a4a9c0992",
"property_id": "docasna_blokace_darce_do",
"property_name": "Property #6",
"last_change": "2023-02-02 00:00:00"
}
]
}
],
"total_items": 1
}
}