List recurring series sorted by next expected date, or return one full series by id.

List recurring series sorted overdue first and then by next expected date with candidates last, plus commitment totals over the returned rows, or return one full series by id. Recurring defaults to predictable obligations such as rent, mortgage installments, subscriptions, and memberships. Candidates are uncurated detections and contribute nothing to commitment totals. Active series contribute; stopped and dismissed series are omitted unless requested by status. Transaction cashflow role is separate from schedule status. Preserve existing agent-confirmed placements, including exceptions.

get/v1/recurring

Request

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

Query parameters

idstring

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

cashflow_role'income' | 'expense' | 'transfer' | 'debt_payment' | 'refund' | 'unknown'

Return only series whose effective cashflow role matches. Use expense for bills and subscriptions; transfer and debt_payment series move money between the user's own accounts or settle a card. Rows promoted before the role was persisted carry none and are left out of a filtered read.

statusstring

Comma-separated statuses to return: candidate, active, stopped, dismissed. Omit for active and candidate. Stopped and dismissed series are history; ask for them by name.

direction'inflow' | 'outflow' | 'neutral'

Return only series moving money out (bills, subscriptions) or in (pay, expected deposits).

account_identity_idstring

Return only series posting to this account identity.

due_withininteger

Return only series expected within this many days of today. Overdue series are included because their next expected date has already arrived.

limitinteger

Maximum recurring series to return. The list is bounded; follow its recurring dataset continuation to page through omitted records. Defaults to 50.

Response

Envelope with recurring items sorted overdue first and then by next expected date with candidates last, plus monthly-equivalent and annual totals over exactly those rows, or one full item with confirmation and evidence 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.