---
title: "List account schedules"
method: GET
path: "/v1/accounts/{accountId}/schedules"
tags: ["Schedules"]
---

# List account schedules

`GET /v1/accounts/{accountId}/schedules`

## Request

- Base URL: `https://sandbox.pismolabs.io/scheduler-payments`
- URL: `https://sandbox.pismolabs.io/scheduler-payments/v1/accounts/{accountId}/schedules`
- Auth: HTTP bearer

List account schedules with paging and filter options.

## Response `200`

Request was processed successfully.

- GetAllScheduleResponse: Response of getting the existing schedules of the account
  - `has_next` boolean: Is there a next page?
  - `next_cursor` string: Cursor value to apply in a subsequent query to continue pagination
  - `count` integer: Number of items
  - `items` Schedule[]
    - `schedule_id` string: Schedule ID (idempotency field for this operation)
    - `schedule_kind` 'SINGLE' | 'MULTIPLE' | 'PRE': Schedule type
    - `description` string: Optional text that describes the operation
    - `schedule_details` ScheduleDetails: Schedule details
      - `type` 'ONCE' | 'RECURRING': Should a schedule be executed once or in a recurring fashion? - `ONCE`: Executed only once on the date specified in `start_date`. - `RECURRING`: Executed repeatedly according to the interval defined in `interval`, within the period between `start_date` and `end_date`. A recurring schedule can run daily, weekly, monthly, or yearly, which is set in the `interval` field.
      - `interval` 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY': Schedule execution frequency
      - `day_type` 'BUSINESS_DAY' | 'CALENDAR_DAY': `BUSINESS_DAY` type ignores weekends and holidays, `CALENDAR_DAY` includes all calendar days.
      - `start_date` string, date-time: Start date of executions in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.
      - `end_date` string, date-time: End date of schedule executions in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.
      - `retries` Retries: Configuration to define retry policy for failed executions.
        - `interval_recurrence` integer: Interval for retries, in minutes
        - `number_of_attempts` integer: Maximum number of execution retries
      - `allow_execution_after_day_change` boolean: Can the schedule be executed after the day changes? For single and transfer schedules that are scheduled for after 11:30pm UTC, this field is required to be `true`.
      - `statement` Statement
        - `id` integer: Pismo ID of the statement linked to the pre-schedule
    - `account_id` integer: Account ID
    - `status` 'CREATED' | 'IN_PROGRESS' | 'CANCELED' | 'COMPLETED': Schedule status
    - `created_at` string, date-time: Date of schedule creation in the UTC-0 RFC3339 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.
    - `metadata` Metadata: This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. The Pismo platform does not perform any validation or processing on this field. **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](ref:get-started-with-pismo-apis#metadata).
    - `pismo_metadata` PismoMetadata: Any key-value object with custom information that must be passed forward in the Pismo authorization flow. Used for internal purposes only.
    - `processing_code` string: Processing code that identifies the credit or debit operation
    - `processing_codes` ProcessingCodes: Object with the processing codes for credit and debit operations
      - `credit` string: Processing code that identifies the credit operation
      - `debit` string: Processing code that identifies the debit operation
    - `amount` number, float: Credit or debit amount
    - `currency_code` string: Three-letter currency code of the operation in ISO 4217.
    - `restrictions` Restrictions: Restrictions applied to the schedule
      - `minimum_daily_available` number, float: Establishes a minimum limit value to always be maintained in the customer's balance. If the value of the customer's balance is lower than the minimum limit value, the schedule is executed, otherwise its execution is stopped and saved as "Executed with restrictions".
      - `minimum_monthly_average_available` number, float: Follows the same logic as `minimum_daily_available`, except it considers an average limit value from the first day of the month until the day before the scheduled execution to compare with the customer’s balance value.
      - `minimum_days_account_inactivity` integer: If the days of account inactivity are greater than this field value, the schedule execution is stopped and saved as "Executed with restrictions".
    - `strategy` 'OVERDRAFT_SWEEP' | 'SWEEP': If the `strategy` field is not specified, you must provide the `amount` field for each transfer in the `transfers` array. The following strategy types determine the transfer amounts when a strategy is specified. - `SWEEP`: Transfers the entire balance from the child account to the parent account. The terms "parent" and "child" refer to account roles, but no relationship validation is performed. Child → Parent - `OVERDRAFT_SWEEEP`: Follows the same logic as `SWEEP`, except when a child account is negative, in which case the main account sends enough money to zero out the child account. Parent → Child
    - `transfers` object[]: List of transfers, including their origin and destination accounts. The `amount` field must be provided if the `strategy` is not specified.
      - `description` string: Transfer description
      - `amount` number, float: Credit or debit amount
      - `metadata` Metadata: This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. The Pismo platform does not perform any validation or processing on this field. **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](ref:get-started-with-pismo-apis#metadata).
      - `to` object: Information about the destination account for the transfer
        - `account_id` integer: Account ID
        - `processing_code` string: Processing code that identifies the credit or debit operation
      - `from` object: Information about the source account for the transfer
        - `account_id` integer: Account ID
        - `processing_code` string: Processing code that identifies the credit or debit operation

## Other responses

- `400`: Bad request
- `403`: Operation forbidden
- `404`: The specified resource was not found
- `500`: Internal server error

---

[API](https://skmtc.dev/pismo/apis/core-platform-payment-scheduler.md) - [All operations](https://skmtc.dev/pismo/apis/core-platform-payment-scheduler/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/core-platform-payment-scheduler/revisions/85d7c15a4b75?raw)