Skip to main content
GET
List record events
In the Heliyos MCP server: heliyos_records_events.

Authorizations

Authorization
string
header
required

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

id
string
required

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.

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

limit
integer
default:20

Events per page, 1 to 100. Defaults to 20.

Required range: 1 <= x <= 100
cursor
string

The 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.

Maximum string length: 200
page
integer

A page number, starting at 1, for page-number paging. Pages are limit events long.

Required range: x >= 1
objectType
string

Has 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.

Maximum string length: 50
eventType

Only 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.
Maximum string length: 100
operationType

Only these operations: CREATE, UPDATE, DELETE. Comma-separated, or repeat the parameter.

Maximum string length: 100
startDate
string<date-time>

Only events at or after this time. An ISO 8601 date or date-time (a date alone means midnight UTC).

endDate
string<date-time>

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).

actorId
string

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.

Maximum string length: 100

Only events whose change summary contains this text, case-insensitive. Up to 200 characters.

Maximum string length: 200

Response

A page of events, newest first.

meta
object
required
data
object[]
required