---
title: "List reports"
method: GET
path: "/v1/reports"
tags: ["Reports"]
---

# List reports

`GET /v1/reports`

Returns an array of reports available for download. Each array element represents an available report, and contains the `reportId`, `reportType`, and `reportFormat` fields associated with that report.

To get the download link for a specific report, store the `reportId` for the report you want, and use it with the [Get a report](/products/payments-odl/api-docs/report_service/reference/openapi/reports/getreport) operation.

## Query parameters

- `created-by` 'USER' | 'SCHEDULER' | 'API' — Query for report types based on the entity that initiated report creation. | Value | Description | |------------|----------------------------------------------------| | SCHEDULER | Get automated system-generated reports. | | USER | Customized reports generated by users through the UI. | | API | Customized reports generated using the API. |

## Response `200`

Returns an array of report metadata for the calling tenant

- ReportsMetadataResponse
  - `reports` ReportMetadata[], required
    - `reportId` string, uuid, required — Unique identifier for a report.
    - `reportName` string — User defined name of the report.
    - `reportType` 'PAYMENT_OPS' | 'RECON' | 'FAILURE_CONVERSION_SSA', required — The report type of the downloadable report.
    - `reportFormat` 'CSV' | 'JSON', required — The report format of the downloadable report.
    - `reportStatus` 'PENDING' | 'READY' | 'FAILED' | 'EMPTY', required — The status of the report.
    - `startDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) start date (inclusive) of the report.
    - `endDate` string, date-time, required — The [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) end date (inclusive) of the report. **Note**: Must be after `startDate`, but no more than 90 days after.
    - `createdOn` string, date-time — Report creation time
    - `reportCreatedBy` string — Identifies the entity that initiated the report creation. | Value | Description | |-------------|----------------------------------------------------| | SCHEDULER | Automated system-generated report initiated by the scheduler. | | API | User-generated report initiated through the API. | | [full name] | Full name of the user who initiated the creation of the report through the UI. | | null | Legacy support for older reports. |

## Other responses

- `400` — Bad Report Request
- `403` — Forbidden

---

[API](https://skmtc.net/ripple/apis/report-service-api.md) · [All operations](https://skmtc.net/ripple/apis/report-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/report-service-api/revisions/54de4d3166be/schema)