curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/records/{id}/events \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/records/{id}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/records/{id}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Events fetched successfully",
"pagination": {
"limit": 20,
"next_cursor": "NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2"
}
},
"data": [
{
"_id": "6728d2e4b2c3d4e5f6a7b8d0",
"timestamp": "2026-11-04T10:12:00.000Z",
"metadata": {
"eventType": "AUDIT",
"operationType": "UPDATE",
"objectType": "company",
"objectUUID": "66f1a8c3e4b0a1b2c3d4e5f6",
"organizationUUID": "66a0f1e2d3c4b5a697887766",
"actor": {
"type": "USER",
"uuid": "66a0f1e2d3c4b5a697881111",
"name": "Priya Patel"
}
},
"changeSummary": "Priya Patel changed the stage of Northwind Traders from Discovery to Proposal.",
"originalVersion": {
"data": {
"company_name": "Northwind Traders",
"stage": "Discovery"
}
},
"updatedVersion": {
"data": {
"company_name": "Northwind Traders",
"stage": "Proposal"
}
}
},
{
"_id": "6728c9b0b2c3d4e5f6a7b8cf",
"timestamp": "2026-11-04T09:40:00.000Z",
"metadata": {
"eventType": "AUDIT",
"operationType": "CREATE",
"objectType": "task",
"objectUUID": "6728c9afb2c3d4e5f6a7b8ce",
"organizationUUID": "66a0f1e2d3c4b5a697887766",
"actor": {
"type": "AGENT",
"uuid": "3f9a1c2b7d4e4f0a9b8c7d6e5f4a3b2c",
"name": "Account Researcher"
}
},
"changeSummary": "Account Researcher created the task Send security questionnaire to Northwind Traders.",
"originalVersion": null,
"updatedVersion": {
"title": "Send security questionnaire to Northwind Traders",
"status": "backlog",
"relationships": [
{
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"objectType": "company"
}
]
}
}
]
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}List record events
Serves records only (companies, people, deals and custom objects). Heliyos looks the record up, checks that you may view its object, and uses the record’s own object type. For a task use List task events.
Returns the change history of a company, person or deal, newest first: who created, changed or deleted what, and when, with a one-line summary of each change and before and after snapshots.
The list includes the record’s own events and the events of anything linked to it: a task,
note, email thread, meeting, comment, file or other record whose relationships names this
record in either snapshot. Check metadata.objectType and metadata.objectUUID to tell them apart.
By default the list pages with a cursor: pass limit, then send meta.pagination.next_cursor
back as cursor. Sending page switches to page-number paging, where meta.pagination holds
page, limit, total and hasMore. See Pagination.
Filters combine with AND. eventType and operationType match any of the values you send.
curl --request GET \
--url https://api-prod.heliyos.ai/v1/platform/records/{id}/events \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.heliyos.ai/v1/platform/records/{id}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/records/{id}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"meta": {
"message": "Events fetched successfully",
"pagination": {
"limit": 20,
"next_cursor": "NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2"
}
},
"data": [
{
"_id": "6728d2e4b2c3d4e5f6a7b8d0",
"timestamp": "2026-11-04T10:12:00.000Z",
"metadata": {
"eventType": "AUDIT",
"operationType": "UPDATE",
"objectType": "company",
"objectUUID": "66f1a8c3e4b0a1b2c3d4e5f6",
"organizationUUID": "66a0f1e2d3c4b5a697887766",
"actor": {
"type": "USER",
"uuid": "66a0f1e2d3c4b5a697881111",
"name": "Priya Patel"
}
},
"changeSummary": "Priya Patel changed the stage of Northwind Traders from Discovery to Proposal.",
"originalVersion": {
"data": {
"company_name": "Northwind Traders",
"stage": "Discovery"
}
},
"updatedVersion": {
"data": {
"company_name": "Northwind Traders",
"stage": "Proposal"
}
}
},
{
"_id": "6728c9b0b2c3d4e5f6a7b8cf",
"timestamp": "2026-11-04T09:40:00.000Z",
"metadata": {
"eventType": "AUDIT",
"operationType": "CREATE",
"objectType": "task",
"objectUUID": "6728c9afb2c3d4e5f6a7b8ce",
"organizationUUID": "66a0f1e2d3c4b5a697887766",
"actor": {
"type": "AGENT",
"uuid": "3f9a1c2b7d4e4f0a9b8c7d6e5f4a3b2c",
"name": "Account Researcher"
}
},
"changeSummary": "Account Researcher created the task Send security questionnaire to Northwind Traders.",
"originalVersion": null,
"updatedVersion": {
"title": "Send security questionnaire to Northwind Traders",
"status": "backlog",
"relationships": [
{
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"objectType": "company"
}
]
}
}
]
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_records_events.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Path Parameters
The record's id: a company, person, deal or custom object record. Ids of tasks, notes and interactions answer 404; for a task's history use List task events.
^[0-9a-fA-F]{24}$Query Parameters
Events per page, 1 to 100. Defaults to 20.
1 <= x <= 100The next_cursor from the previous page. When you send both cursor and page, cursor wins.
next_cursor from the previous page; only valid with the default sort.
200A page number, starting at 1, for page-number paging. Pages are limit events long.
x >= 1Has no effect on records created in Heliyos: the record's own type is always used. Only read for a record with no stored type. Leave it out.
50Only events of these types. Comma-separated, or repeat the parameter. Exact, case-sensitive values:
AUDIT: changes made by people and workers.INTERACTION: email threads and meetings synced, updated or analysed.ENRICHMENT: data enrichment results.
100Only these operations: CREATE, UPDATE, DELETE. Comma-separated, or repeat the parameter.
100Only events at or after this time. An ISO 8601 date or date-time (a date alone means midnight UTC).
Only events at or before this time. An ISO 8601 date or date-time (a date alone means midnight UTC, so send the next day or a full time to include a whole day).
Only events by this actor, matched exactly against metadata.actor.uuid: a user id for a person's changes, a worker run id for a worker's, or system.
100Only events whose change summary contains this text, case-insensitive. Up to 200 characters.
200Was this page helpful?

