notes

Search notes

Read notes: free-form annotations on people and companies, and the stickers on a workflow canvas (object_type workflow). Scope with filter object_sid for one object's notes or one workflow's stickers (read them before changing a workflow), or search team-wide with filter q (FULLTEXT over body); include person and company to cite names. page_size 0 = counts only; counts.groups.object_type rides every response. Not for system facts (sends, replies): the activities timeline.

Contract:

  • MCP tool search_notes, registry package mcp.playtables/notes, mount playtables.pipeline.
  • Operation search, response envelope search.
  • Flags: read only.
post/api/notes/search

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

includestring[]

Relations to attach to every item; omit for the bare rows.

page_sizeinteger

0..500, default 50; 0 = counts only, 1 = the first row.

cursorstring nullable

pagination.next_cursor of the previous page.

Response

search success envelope.

successtrue required
operation'search' required
applied_filtersobject required
includesstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.