List compact typed interpretation rules or return one full rule by id.

List compact typed interpretation rules or return one full rule by id.

get/v1/rules

Request

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

Query parameters

idstring

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

family'normalization'

Restrict to one rule family.

status'active' | 'disabled'

Return only records in this state.

targetstring

Restrict to rules that change this part of a record.

limitinteger

Rules are projected through their basis transactions for visibility, so their page ceiling stays at 100.

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

Envelope with compact typed rules, or one full rule with authority and basis when id is supplied.

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.