---
title: "List schedules"
method: GET
path: "/schedules/v1"
tags: ["Schedules"]
---

# List schedules

`GET /schedules/v1`

Returns a paginated list of schedules for the calling application, optionally filtered by
consent and status.

## Query parameters

- `consentId` string, uuid
- `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.
- `page` integer
- `size` integer

## Response `200`

A paginated list of schedule summaries.

- ScheduleSummaryListResponse
  - `content` ScheduleSummaryResponse[], required — The page of schedule summaries.
    - `schedule_id` string, uuid, required — The id of the schedule.
    - `consent_id` string, uuid, required — The id of the consent the schedule belongs to.
    - `kind` 'RECURRING' | 'EXPLICIT', required — Discriminates between recurring and explicit schedules.
    - `status` 'PENDING' | 'ACTIVE' | 'PAUSED' | 'CONSENT_BLOCKED' | 'CANCELLED' | 'COMPLETED', required — 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.
    - `created_at` string, date-time, required — The date and time the schedule was created.
    - `plan_summary` SchedulePlanSummary, required — Summary of the schedule's plan. The populated fields depend on the schedule `kind`: recurring schedules populate `amount`, `period_unit`, `start_date` and `end_date`; explicit schedules populate `planned_count`, `first_payment_date` and `last_payment_date`.
      - `amount` ScheduleAmount — A monetary amount for a scheduled payment.
        - `value` number, required — The amount of money in the currency specified.
        - `currency` string, required — The currency of the amount.
      - `period_unit` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' — The time unit on which a recurring schedule repeats. - `DAY` — the schedule repeats every day. - `WEEK` — the schedule repeats every week. - `MONTH` — the schedule repeats every month. - `YEAR` — the schedule repeats every year.
      - `start_date` string, date, nullable — The start date. Present for recurring schedules.
      - `end_date` string, date, nullable — The end date, when bounded. Present for recurring schedules.
      - `planned_count` integer, nullable — The number of planned payments. Present for explicit schedules.
      - `first_payment_date` string, date, nullable — The date of the first planned payment. Present for explicit schedules.
      - `last_payment_date` string, date, nullable — The date of the last planned payment. Present for explicit schedules.
    - `next_payment` ScheduleExecutionEntry — A single planned payment execution.
      - `execute_on` string, date, required — The date on which this payment should be executed.
      - `amount` ScheduleAmount, required — A monetary amount for a scheduled payment.
        - `value` number, required — The amount of money in the currency specified.
        - `currency` string, required — The currency of the amount.
      - `reference` string, nullable — Optional per-execution reference passed to the bank.
  - `page` PageMetadata, required — Metadata about the current page of results
    - `number` integer, required — The current page being returned by the API
    - `size` integer, required — The page size requested
    - `total_elements` integer, required — The total number of elements in all pages
    - `total_pages` integer, required — The total number of pages retrievable
    - `sort` string[] — Sort parameters applied to the results

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)