---
title: "List payouts for a site"
method: GET
path: "/shop/reports/payouts"
tags: ["Reports"]
---

# List payouts for a site

`GET /shop/reports/payouts`

Use this endpoint to retrieve a list of payouts for a site.

## Query parameters

- `site_id` string, uuid
- `date_from` string, date
- `date_to` string, date
- `status` 'not_started' | 'processing' | 'processed' | 'failed'
- `page` integer
- `per_page` integer

## Response `200`

The list of `Payout` resources was successfully retrieved.

- ListPayoutsResponse
  - `data` PayoutSummary[], required
    - `id` string, mongo-id — The ID of the payout.
    - `status` string — The status of the payout.
    - `payout_date` string, date — The date that the payout will be processed.
    - `processed_date` string, date-time, nullable — The date and time that the payout was processed.
    - `num_charges` integer — The number of charges included in this payout.
    - `amount` string — The total amount of money included in this payout.
    - `currency` string — The currency code of this payout.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)