Read Candor's weekly reviews, newest first.

Each review lists the areas worth the agent's attention and the gaps worth filling, with what it marked settled since the review before. An area carries its id within the review, item_id (the review.area item id that reviews.update takes as area), its title, topic (income, spending, cash, debt, savings, retirement, tax, protection, housing, family, estate, goals, business, investing, work, other), kind (problem, opportunity, question), what was noticed, why it matters, what is unknown, since_last_review (new, unchanged, updated), outcome once the agent or the person recorded one (state looked_into or set_aside, by agent or person, on, and found), and refs, the records behind it. Areas state no figures; the records do. A gap carries what to settle, which area it changes, what to check or ask, and record_as (rule_on_the_payee, note_on_the_record, note, connect_the_account, goal). The latest review is also in the opening. Records and pagination live under data.page.

get/v1/reviews

Request

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

Query parameters

limitinteger

Reviews per page.

cursorstring

The exact next_cursor a previous page returned.

Response

Weekly reviews 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.