---
title: "List report schedules"
method: GET
path: "/ledger/v1/report-schedules"
tags: ["Wallets"]
---

# List report schedules

`GET /ledger/v1/report-schedules`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/ledger/v1/report-schedules`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/ledger/v1/report-schedules/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a paginated list of report schedules for the authenticated user's account. Returns all schedules created by the user with their current configuration and delivery preferences.

## Query parameters

- `page` integer
- `size` integer

## Response `200`

Report schedules retrieved successfully

- object: Complete pagination metadata for paginated responses
  - `content` object[]: List of report schedules
    - `id` string, uuid: Unique identifier for the report schedule
    - `createdBy` string: Base64 encoded identifier of the user who created the schedule
    - `accountReference` string, uuid: Reference to the account this report schedule belongs to
    - `time` string: The scheduled time for report generation in 24-hour format
    - `timezone` string: The timezone used for scheduling
    - `frequencyType` 'DAILY' | 'WEEKLY' | 'MONTHLY': The frequency of report generation
    - `frequencyDay` integer: The specific day for report generation based on frequency type
    - `format` 'CSV' | 'PDF' | 'JSON': The file format of the generated report
    - `channel` 'WEBHOOK' | 'EMAIL': The delivery method for the report
    - `email` string, email: Email address for delivery (null when channel is WEBHOOK)
    - `reportType` 'TRANSACTION' | 'BALANCE' | 'SUMMARY': The type of report to be generated
  - `pageable` Pageable: Pagination information for the request
    - `pageNumber` integer: Current page number (0-based)
    - `pageSize` integer: Number of items per page
    - `sort` string[]: Sort criteria applied
    - `offset` integer: Offset of the first item
    - `paged` boolean: Whether the result is paged
    - `unpaged` boolean: Whether the result is unpaged
  - `last` boolean: Whether this is the last page
  - `totalPages` integer: Total number of pages
  - `totalElements` integer: Total number of elements across all pages
  - `first` boolean: Whether this is the first page
  - `size` integer: Page size
  - `number` integer: Current page number (0-based)
  - `sort` string[]: Sort criteria for the page
  - `numberOfElements` integer: Number of elements in the current page
  - `empty` boolean: Whether the page is empty

## Other responses

- `400`: Bad request - Invalid query parameters

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)