v1
latestOpenAPI 3.1.02026-07-2478315484.9 KBSchedules
List schedules
Returns a paginated list of schedules for the calling application, optionally filtered by consent and status.
get/schedules/v1
Query parameters
consentIdstring uuid
Filter schedules to a single consent.
status'PENDING' | 'ACTIVE' | 'PAUSED' | 'CONSENT_BLOCKED' | 'CANCELLED' | 'COMPLETED'
The lifecycle status of a schedule.
- PENDING — registered, not yet active.
- ACTIVE — active; payments are attempted on their due dates.
- PAUSED — temporarily paused; no payments attempted until resumed.
- CONSENT_BLOCKED — the underlying consent is no longer usable.
- CANCELLED — terminated by the client or due to consent state.
- COMPLETED — all planned payments have been executed.
Filter schedules by status.
pageinteger
The page you're requesting - returns page 0 of a response if not specified.
sizeinteger
The number of objects you want to return as a page size.
Response
A paginated list of schedule summaries.