---
title: "Get all reports"
method: GET
path: "/reports"
tags: ["Reports"]
---

# Get all reports

`GET /reports`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/reports`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `reports`, `reports:view`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/reports/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the list of reports and their details.

## Query parameters

- `created_after` string, date-time
- `created_before` string, date-time
- `entity_id` string
- `limit` integer
- `pagination_token` string

## Response `200`

Reports retrieved successfully

- ReportListResponse: The list of reports in the response.
  - `count` integer: The total number of reports on the current page.
  - `limit` integer: The maximum number of results included per page.
  - `data` ReportResponse[]: The list of reports from the current page.
    - `id` string: The report ID.
    - `created_on` string, date-time: The date and time the report was created.
    - `last_modified_on` string, date-time: The date the report was last modified.
    - `type` 'Authentication' | 'Balance' | 'BalanceBreakdown' | 'BankPayouts' | 'CardPayouts' | 'Disputes' | 'FinancialActions' | 'FinancialActionsByPayout' | 'FraudDetection' | 'IssuingAuthorizations' | 'IssuingCards' | 'IssuingChargebacks' | 'IssuingPresentments' | 'IssuingSettlementActivity' | 'IssuingSettlementSummary' | 'Manifest' | 'Payments' | 'PayoutSummary' | 'RealTimeAccountUpdater' | 'ReportedFraudulentTransactions' | 'Retrievals' | 'SettlementBreakdown' | 'SettlementStatement': The report type.
    - `description` string: The report description.
    - `account` AccountResponse: The client and entity details.
      - `client_id` string: The client ID.
      - `entity_id` string: The entity ID.
    - `tags` string[]: The list of tags for filtering.
    - `from` string, date-time: The reporting period's start date and time.
    - `to` string, date-time: The reporting period's end date and time.
    - `files` FileResponse[]: The list of files included in the report.
      - `id` string: The file ID.
      - `filename` string: The file name.
      - `format` string: The file format.
      - `_links` object: The link to retrieve the file from.
        - `self` Link
          - `href` string, required: The link URL
    - `_links` object: The links object.
      - `self` Link
        - `href` string, required: The link URL
  - `_links` object: The links object.
    - `self` Link
      - `href` string, required: The link URL
    - `next` Link
      - `href` string, required: The link URL

## Other responses

- `401`: Unauthorized – Access token may be invalid or missing
- `422`: Unprocessable entity

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)