v1

latestOpenAPI 3.1.02026-07-26183980.3 KB

external

external-v2

List Notes

List notes visible to the authenticated caller with cursor pagination. When multiple contains_* fields are true, a note may match any of them. Results are ordered by order_by and return next_page when additional rows are available. For relevance-ranked retrieval by query, use POST /v2/notes/search.

get/v2/notes

Query parameters

limitinteger nullable

Maximum number of notes in this page. Use smaller values for lower latency. Default is 50; valid range is 1 to 100.

pagestring nullable

Opaque cursor from a previous list response. Omit for the first page. IMPORTANT: Reuse with the same filters and order_by settings.

order_by'created_at' | 'updated_at'

Sort key for pagination boundaries. Use updated_at (default) for recency feeds. Use created_at for creation-order views.

collection_idstring uuid nullable

Optional collection filter by UUID. When set, only notes linked to this collection are returned.

filter_by_created_afterstring date-time nullable

Optional inclusive lower bound for note creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_created_beforestring date-time nullable

Optional inclusive upper bound for note creation time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_updated_afterstring date-time nullable

Optional inclusive lower bound for note update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

filter_by_updated_beforestring date-time nullable

Optional inclusive upper bound for note update time (ISO 8601). The timestamp must include a timezone offset such as Z or +01:00.

contains_open_tasksboolean

When true, include notes that contain at least one open task item. When multiple contains_* fields are true, notes matching any selected filter may be returned.

contains_tasksboolean

When true, include notes that contain at least one task item (open or closed). When multiple contains_* fields are true, notes matching any selected filter may be returned.

contains_imagesboolean

When true, include notes that contain image media (including image and GIF kinds). When multiple contains_* fields are true, notes matching any selected filter may be returned.

contains_filesboolean

When true, include notes that contain file-like attachments (including file and PDF kinds). When multiple contains_* fields are true, notes matching any selected filter may be returned.

include_note_contentboolean

When true, include full markdown content for each returned note. IMPORTANT: This increases payload size and can increase latency.

Response

next_pagestring nullable

Opaque cursor for the next page of results. Omitted when there are no more results.

request_idstring required

Identifier for this API request. Useful for tracing and support.

totalinteger required

Total number of matching notes before pagination is applied.

Example response

{
  "next_page": "eyJpZCI6IjAxOGY4ZDBkLTVhM2MtN2FmYy04MzIxLTJmNmY2ZTBmZWZhYiIsIm9yZGVyX2J5IjoidXBkYXRlZF9hdCIsInJlcXVlc3RfZmluZ2VycHJpbnQiOiJkZjk4MDI5YjhhZGI0M2Q4NmI5YTRkYjQ3ZTZhYWE4NjkyZjUzZGFiZDQ4ZDg0MjYxZWI2YjY2MDVhODI2N2Q4IiwidmFsdWUiOiIyMDI1LTA1LTA0VDE0OjIwOjExWiJ9",
  "request_id": "api-request-018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
  "results": [
    {
      "audio_recording_ids": [
        "78ff64bc-09e3-4fd7-a4b9-53c258f35619"
      ],
      "collection_ids": [
        "59508b41-8770-4855-aa37-302b1e09aee7",
        "026b426c-14fb-4f22-8d98-7a9121bfaec8"
      ],
      "content": "# Weekly Planning\n\n## Priorities\n- Customer interviews\n- Ship timeline view\n",
      "created_at": "2025-05-01T10:05:45Z",
      "id": "018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
      "snippet": "Quarterly kickoff prep",
      "title": "Weekly Planning",
      "updated_at": "2025-05-04T14:20:11Z"
    }
  ],
  "total": 12
}