> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # 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](/api-reference/pagination). Filters combine with AND. `eventType` and `operationType` match any of the values you send. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_records_events`](https://docs.heliyos.ai/mcp/tools/timeline-and-activity#heliyos-records-events). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/platform/records/{id}/events openapi: 3.0.3 info: title: Heliyos API version: 1.0.0 description: >- The REST API for Heliyos, the AI operating system for revenue. Every request is scoped to the workspace that owns the API key. Responses are JSON in a `{ meta, data }` envelope; errors use `{ message, error: { code, message, details } }`. contact: name: Heliyos support email: soham@heliyos.ai url: https://www.heliyos.ai servers: - url: https://api-prod.heliyos.ai description: Production security: - bearerAuth: [] tags: - name: Workspace description: >- The workspace your API key belongs to, and the log of credits it has used. Every other call in this API is scoped to this workspace. - name: Schemas description: >- Objects are your record types: companies, people, deal pipelines and any custom objects you add. Each object has fields, and a field's type decides what its records can hold. - name: Records description: >- Records are the rows of an object (base schema): companies, people, deals and custom objects. A record holds field values keyed by the object's field keys and links to other records. - name: Timeline description: >- The AI-written timeline of a company, person or deal: summary entries Heliyos writes on a schedule. For the exact change history see Activities, and for emails and meetings see Interactions. - name: Activities description: >- The change history of records and tasks: who created, changed or deleted what, and when. People, workers and the system each appear as the actor on the changes they make. - name: Interactions description: >- Email threads and meetings synced from connected mailboxes and calendars, linked to the people and companies they involve. - name: Notes description: >- Free-text notes, optionally linked to records, tasks and interactions. Notes show up on the timeline of every record they are linked to, and workers read them as customer memory. - name: Tasks description: >- Work items for people and workers, optionally linked to records. A task can be assigned to people, to workers, or both, and workers can be started on it directly. - name: Workers and runs description: >- Workers are the AI teammates of your workspace (the API calls them agents). Define what each one does and what starts it, ask Heliyos to do work, and follow every run, its steps and the reviews it waits on. - name: Reviews description: >- Reviews keep the team in control of consequential work. When a worker wants to send an email, change a deal, book a meeting, act in a connected app or needs a person's answer, the action waits as a review until someone approves or rejects it. - name: Scouts description: >- Scouts watch companies and the web for events such as funding rounds, product launches, leadership changes or press coverage, and record each finding as a signal. A workspace Scout defines what to look for; company Scouts are its copies running on individual companies. - name: Signals description: >- Signals are what Scouts find: one event, such as a funding round or a new executive, with a summary, its sources and the company it is about. New signals are unread until you mark them read. - name: Watchlist description: >- The watchlist is the set of companies your workers monitor. Each watched company uses one Watcher from your plan: the workers keep it enriched, pull in its emails and meetings, and run Scouts on it. - name: Knowledge base description: >- What your workers know about the business: the business context, four fixed texts (products, pain points, value proposition, qualification criteria) and any custom entries your team adds. Workers read it on their next run. Files your workers read live under Files, with kind `knowledge_base`. - name: Files description: >- Knowledge base files that workers read, and files attached to records, tasks and other resources. The API calls them attachments. Uploading takes three calls: get an upload URL, send the bytes to it, then create the file. - name: Labels description: >- Label groups that sort your email threads, for example Intent or Pricing questions. Heliyos files each classified thread under a group, and each group holds the more specific labels it brings together. The API calls them classification labels. - name: Team description: >- The people in your workspace and their roles: joined members and pending invitations. Inviting someone sends them an email. - name: Notification settings description: >- Which workspace events send notification emails, how often, and to whom. There is one settings document per workspace, shared by everyone in it. paths: /v1/platform/records/{id}/events: get: tags: - Activities summary: List record events description: >- 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](/api-reference/pagination). Filters combine with AND. `eventType` and `operationType` match any of the values you send. operationId: listRecordEvents parameters: - name: id in: path required: true schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: >- 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. example: 66f1a8c3e4b0a1b2c3d4e5f6 - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 20 description: Events per page, 1 to 100. Defaults to 20. example: 20 - name: cursor in: query required: false schema: type: string maxLength: 200 description: >- next_cursor from the previous page; only valid with the default sort. description: >- The `next_cursor` from the previous page. When you send both `cursor` and `page`, `cursor` wins. - name: page in: query required: false schema: type: integer minimum: 1 description: >- A page number, starting at 1, for page-number paging. Pages are `limit` events long. - name: objectType in: query required: false schema: type: string maxLength: 50 description: >- 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. - name: eventType in: query required: false schema: anyOf: - type: array items: type: string maxLength: 100 - type: string maxLength: 2000 description: >- 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. example: AUDIT,ENRICHMENT - name: operationType in: query required: false schema: anyOf: - type: array items: type: string maxLength: 100 - type: string maxLength: 2000 description: >- Only these operations: `CREATE`, `UPDATE`, `DELETE`. Comma-separated, or repeat the parameter. example: UPDATE - name: startDate in: query required: false schema: type: string format: date-time description: >- Only events at or after this time. An ISO 8601 date or date-time (a date alone means midnight UTC). example: '2026-11-01T00:00:00.000Z' - name: endDate in: query required: false schema: type: string format: date-time description: >- 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). example: '2026-11-04T23:59:59.999Z' - name: actorId in: query required: false schema: type: string maxLength: 100 description: >- 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`. example: 66a0f1e2d3c4b5a697881111 - name: search in: query required: false schema: type: string maxLength: 200 description: >- Only events whose change summary contains this text, case-insensitive. Up to 200 characters. example: stage responses: '200': description: A page of events, newest first. content: application/json: schema: type: object required: - meta - data properties: meta: type: object required: - message properties: message: type: string description: A human-readable summary of the result. pagination: $ref: '#/components/schemas/KeysetPagination' data: type: array items: $ref: '#/components/schemas/RecordEvent' example: 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 '400': description: 'VALIDATION_FAILED: a malformed query value or cursor.' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: 'FORBIDDEN_ACTION: you cannot view records of this object.' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- NOT_FOUND: no record with this id in the workspace, or the id belongs to a task, note or interaction. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: KeysetPagination: type: object description: >- Cursor paging. Pass `next_cursor` back as `cursor` with the same `limit` for the next page. required: - limit properties: limit: type: integer description: The page size used for this page. example: 20 next_cursor: type: string description: Cursor for the next page. Absent on the last page. RecordEvent: type: object description: >- One change in the audit trail. Snapshots are stored as they were at the time of the change, with credential values (tokens, secrets, passwords, API keys) replaced by `[REDACTED]`. additionalProperties: true properties: _id: $ref: '#/components/schemas/ObjectId' timestamp: allOf: - $ref: '#/components/schemas/Timestamp' description: When the change happened. metadata: type: object additionalProperties: true properties: eventType: type: string enum: - AUDIT - INTERACTION - ENRICHMENT description: >- `AUDIT`: a person or worker created, changed or deleted something (a record, task, note, comment, file, view and so on). `INTERACTION`: an email thread or meeting was synced, updated or analysed. `ENRICHMENT`: data enrichment wrote to a record. operationType: type: string enum: - CREATE - UPDATE - DELETE description: What happened to the changed resource. objectType: type: string description: >- The kind of resource that changed, for example `company`, `people`, `deals`, `task`, `note`, `comment`, `attachment` (a file) or `interaction`. Older deal events may say `deal`. objectUUID: type: string description: >- The id of the resource that changed. Not always the record you asked for (see the list description). organizationUUID: type: string description: The workspace id. actor: type: object description: Who made the change. properties: type: type: string enum: - USER - AGENT - SYSTEM description: >- `USER`: a person or an API key. `AGENT`: a worker. `SYSTEM`: Heliyos itself, for example the inbox sync. uuid: type: string description: >- For `USER`, the user id. For `AGENT`, the worker run id (older entries say `agent`). For `SYSTEM`, usually `system`. name: type: string description: >- A display name, such as the person's name or the worker's name. changeSummary: type: string description: >- A one-line, human-readable description of the change, written by Heliyos. originalVersion: type: object nullable: true additionalProperties: true description: The resource before the change. Null or empty for a create. updatedVersion: type: object nullable: true additionalProperties: true description: The resource after the change. Null for a delete. ErrorEnvelope: type: object required: - message - error properties: message: type: string description: Same as error.message. error: type: object required: - code - message properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN_ACTION - NOT_FOUND - RATE_LIMITED - CONFLICT - INTERNAL message: type: string details: {} ObjectId: type: string pattern: ^[0-9a-fA-F]{24}$ description: A 24-character hexadecimal id. example: 66f1a8c3e4b0a1b2c3d4e5f6 Timestamp: type: string format: date-time description: An ISO 8601 date-time in UTC. example: '2026-11-04T09:30:00.000Z' securitySchemes: bearerAuth: type: http scheme: bearer description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.