Sign in

v1

latestOpenAPI 3.1.02026-07-26167644759.4 KB
Notes

List notes

Returns a list of notes. Uses cursor pagination.

get/notes

Query parameters

limitinteger
Example:25

Number of notes to return per page (min: 1, max: 50, default: 25).

cursorstring

Base64-encoded cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. Omit for the first page.

modifiedSincestring date-time

Filter notes modified on or after this date. Useful for incremental synchronization. Defaults to beginning of time if not provided.

modifiedUntilstring date-time

Filter notes modified on or before this date. Useful for bounded synchronization snapshots. If omitted, no upper bound is applied.

candidateIdstring

Filter notes linked to this candidate.

clientContactIdstring

Filter notes linked to this client contact.

source'phone' | 'phoneInbound' | 'phoneOutbound' | 'inPerson' | 'onlineMeeting' | 'callAttempted'

Filter notes by source (e.g. phone, inPerson, onlineMeeting).

labelIdsstring[]

Filter notes that have any of the given label IDs.

[
  "label-123",
  "label-456"
]

Response

Successfully retrieved notes. Returns items array with pagination info containing cursor for the next page.