> ## 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 notes > Returns the workspace's notes, newest first. By default the list pages with a cursor: pass `limit`, then send `meta.pagination.next_cursor` back as `cursor` for the next page. To filter, search or sort, send a JSON `filters` object. A custom sort or `page` switches to page-number paging. See [Pagination](/api-reference/pagination) and [Filtering and sorting](/api-reference/filtering). To list only the notes linked to one record, send `{"relatedObjectId": ""}` in `filters`. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_notes_list`](https://docs.heliyos.ai/mcp/tools/notes#heliyos-notes-list). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/platform/notes 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/notes: get: tags: - Notes summary: List notes description: >- Returns the workspace's notes, newest first. By default the list pages with a cursor: pass `limit`, then send `meta.pagination.next_cursor` back as `cursor` for the next page. To filter, search or sort, send a JSON `filters` object. A custom sort or `page` switches to page-number paging. See [Pagination](/api-reference/pagination) and [Filtering and sorting](/api-reference/filtering). To list only the notes linked to one record, send `{"relatedObjectId": ""}` in `filters`. operationId: listNotes parameters: - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 20 description: Notes 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. Only valid with the default order (newest first) and no `page`. - 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` notes long. - name: filters in: query required: false schema: type: string maxLength: 20000 description: >- JSON-encoded filter object (search, filters, sort, page, pageSize). Optional. pageSize above 200 is clamped to 200. description: >- A JSON object, URL-encoded. Keys: - `search` (string): matches text in the title or body, case-insensitive. - `relatedObjectId` (id): only notes linked to this record, task or interaction. - `filters` (array): conditions `{ "field", "operator", "value" }`. Fields: `title`, `content`, `metadata.created.at`, `metadata.created.by`. Operators: `equals`, `not_equals`, `contains`, `after`, `before`, `gt`, `gte`, `lt`, `lte`, `in`, `empty`, `not_empty`. - `sort` (array): `{ "field", "direction" }` with direction `asc` or `desc`, for example `[{"field": "metadata.updated.at", "direction": "desc"}]`. example: '{"search":"pricing","relatedObjectId":"66f1a8c3e4b0a1b2c3d4e5f6"}' responses: '200': description: A page of notes. 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/Note' example: meta: message: Notes fetched successfully. pagination: limit: 20 next_cursor: NjZmMWE4YzNlNGIwYTFiMmMzZDRlNWY2 data: - _id: 6720b1f4c2a9e3d1f0a4b5c6 organizationId: 66a0f1e2d3c4b5a697887766 title: Pricing call follow-up content: >- Champion confirmed budget for Q1. Procurement wants a security review first. relationships: - objectId: 66f1a8c3e4b0a1b2c3d4e5f6 schemaId: 66a0f1e2d3c4b5a697880001 objectType: company metadata: created: at: '2026-11-04T09:30:00.000Z' by: 66a0f1e2d3c4b5a697881111 updated: at: '2026-11-04T09:30:00.000Z' by: 66a0f1e2d3c4b5a697881111 '400': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: Not found 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. Note: type: object properties: _id: $ref: '#/components/schemas/ObjectId' organizationId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace the note belongs to. title: type: string description: The note's title. Can be an empty string. content: type: string description: The note's body, as plain text or simple HTML. relationships: type: array description: The records, tasks and interactions the note is linked to. items: $ref: '#/components/schemas/Relationship' metadata: $ref: '#/components/schemas/AuditMetadata' 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 Relationship: type: object description: >- A linked resource, hydrated with a short summary so it can be shown without another call. properties: objectId: $ref: '#/components/schemas/ObjectId' schemaId: type: string nullable: true description: The linked record's object id, when the link points at a record. objectType: type: string nullable: true description: >- `company`, `people`, `deals`, a custom object type, `task`, `interaction` or `meeting`. data: type: object additionalProperties: true description: >- A summary of the linked resource. For a record, its field values (for example `company_name` and `logo`, or `people_name`). For a task, `title` and `status`. For an interaction, `subject` and `channelType`. Empty when the target no longer exists. schema: type: object nullable: true additionalProperties: true description: >- The linked record's object (`_id`, `name`, `objectType`, `fields`). Present on single-resource reads. AuditMetadata: type: object description: Who created and last changed the resource, and when. properties: created: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: allOf: - $ref: '#/components/schemas/ObjectId' description: Id of the user (or the API key's owner) who created it. updated: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: allOf: - $ref: '#/components/schemas/ObjectId' description: Id of the user who last changed it. 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.