List financial impacts or return one impact by id.

List financial impacts or return one impact by id.

get/v1/impacts

Request

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

Query parameters

idstring

Return this one impact with one page of its append-only history instead of a list.

state'identified' | 'acted' | 'outcome_observed' | 'realized' | 'closed_without_value' | 'reverted'

Return only impacts at this lifecycle state. This is separate from how strongly a value is evidenced.

limitinteger

Maximum impacts to list, or maximum history events when id is present. Ask for what you will read; impacts come back with their value projections, so the ceiling is 100.

cursorstring

Continue the same filtered list or impact history from the prior envelope's pagination.next_cursor.

Response

Financial impact 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.