List Candor actions and why they happened, or return one action with its outcomes and scopes.

List Candor actions and why they happened, or return one action with its outcomes and scopes.

get/v1/actions

Request

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

Query parameters

idstring

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

task_keystring

Return only actions labelled with this task key.

include_pulseboolean

Include routine workspace pulse actions that are hidden from the default orientation view.

limitinteger

Maximum records to return in one page. The supported range is 1 through 1000; the default stays small.

cursorstring

Continue the same filtered read from pagination.next_cursor. The cursor is bound to the exact filters of the read that issued it; replay every other argument unchanged, or start again without cursor.

Response

Action history 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.