Sign in

v2

latestOpenAPI 3.1.02026-07-2664759910.6 KB
external
external-v2

Extended Search Notes

Search notes and note-linked attachments together. Returns note hits with attachment match context for PDFs, images, audio recordings, calendar events, and emails. Use returned attachment IDs with the attachment tools for deeper inspection.

post/v2/notes/extended-search

Request body

exclude_note_idsstring[]

Note UUIDs to exclude from this result set. Use this to avoid returning notes already inspected by the caller.

filter_by_collection_idsstring[]

Optional collection UUID filters. When provided, results are limited to notes in any listed collection.

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.

limitinteger

Maximum number of note hits to return. Default is 10; valid range is 1 to 100.

next_page_cursorstring nullable

Opaque cursor from a previous extended search response. Omit for the first page.

querystring required

Required text query for searching notes and note-linked attachments. The query must contain at least one non-whitespace character.

sort_by'RELEVANCE' | 'DATE'

Example request

{
  "filter_by_updated_after": "2025-04-01T14:30:45Z",
  "filter_by_updated_before": "2025-04-30T23:59:59Z"
}

Response

OK

has_next_pageboolean required

Whether another request can return more matching notes.

next_page_cursorstring nullable

Opaque cursor for the next page of results.

request_idstring required

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

Example response

{
  "has_next_page": false,
  "next_page_cursor": null,
  "request_id": "api-request-018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
  "results": [
    {
      "attachment_matches": [
        {
          "attachment_id": "2511691e-cfd2-47bc-a4b6-0104234ee1af",
          "attachment_kind": "pdf",
          "filename": "renewal-terms.pdf",
          "highlighted_snippets": [
            "Renewal pricing is fixed for the first year."
          ],
          "is_semantic_match": true,
          "page_number": 3,
          "total_pages": 8
        }
      ],
      "created_at": "2025-03-18T11:00:00Z",
      "id": "018f8d0d-5a3c-7afc-8321-2f6f6e0fefab",
      "note_summary": "Notes and attachments related to vendor renewal.",
      "snippet": "The renewal terms are attached as a PDF.",
      "title": "Vendor Contract Notes",
      "updated_at": "2025-04-22T16:12:34Z"
    }
  ]
}