List bounded agent-authored notes or return one note by id.

List bounded agent-authored notes or return one note by id.

get/v1/notes

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/notes
  • Auth: HTTP bearer

Query parameters

idstring

Return this one record instead of a list. Use the exact id a prior call returned.

status'active' | 'all' | 'resolved'

Return only records in this state.

dueboolean

Return only notes whose revisit time has arrived. This is the set an opening surfaces.

beforestring date-time

Inclusive upper bound on the revisit time. A note exactly on the boundary is returned, so adjacent windows built from these bounds overlap by one instant.

afterstring date-time

Inclusive lower bound on the revisit time. A note exactly on the boundary is returned, so adjacent windows built from these bounds overlap by one instant.

contextboolean

Return active shared-context notes only, newest update first, under data.page.notes with data.page.pagination. Use with limit and the returned cursor, without other filters.

cursorstring

Opaque continuation returned by a context-only read. Follow next_actions to retrieve every remaining active context note; keep the original context and status selection.

updated_afterstring date-time

Return only records changed after this time, for catching up rather than re-reading everything. Pair it with status all; the default active status rejects it as unsupported_note_update_filters.

aboutstring
Example:transactions:TRANSACTION_ID

Return only notes linked to this record, written as RESOURCE:ID, such as transactions:TRANSACTION_ID. A bare id is rejected as invalid_note_about.

searchstring

Full-text search over note bodies, matching whole tokens rather than substrings: script will not find subscription. A miss is not evidence that no note exists.

limitinteger

Maximum records to return. Ask for what you will read; a large page costs context you may need for the answer.

Response

Note envelope.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

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