> ## Documentation Index
> Fetch the complete documentation index at: https://docs.partnero.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List payout requests

> Retrieve a paginated list of payout requests from all partners in your program

## Endpoint

```
GET https://api.partnero.com/v1/payout_requests
```

Returns payout requests from all partners, wherever they came from: the API, the partner portal or automations.

## Query parameters

| Parameter | Type | Default | Description |
| - | - | - | - |
| `limit` | integer | 10 | Number of results per page (10-100) |
| `page` | integer | 1 | Page number for pagination |
| `sort` | string | `desc` | Sort by creation date: `desc` (newest first) or `asc` |

## Request

```bash cURL theme={null}
curl --location 'https://api.partnero.com/v1/payout_requests?limit=50' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "data": [
      {
        "id": 556,
        "partner": "partner_456",
        "status": "requested",
        "amount": 50.0,
        "amount_units": "usd",
        "payout_gateway": "wise",
        "created_by": "partner",
        "created_at": "2026-09-29T11:02:10.000000Z",
        "updated_at": "2026-09-29T11:02:10.000000Z"
      },
      {
        "id": 555,
        "partner": "partner_123",
        "status": "approved",
        "amount": 200.0,
        "amount_units": "usd",
        "payout_gateway": "paypal",
        "created_by": "api",
        "created_at": "2026-09-29T10:15:00.000000Z",
        "updated_at": "2026-09-29T10:20:00.000000Z"
      }
    ],
    "links": {
      "first": "https://api.partnero.com/v1/payout_requests?page=1",
      "last": null,
      "prev": null,
      "next": null
    },
    "meta": {
      "current_page": 1,
      "from": 1,
      "path": "https://api.partnero.com/v1/payout_requests",
      "per_page": 10,
      "to": 2
    },
    "status": 1
  }
  ```
</ResponseExample>

### Response fields

<Accordion title="Payout requests — data[]">
  | Field | Type | Description |
  | - | - | - |
  | `id` | integer | Payout request ID |
  | `partner` | string | Partner ID |
  | `status` | string | Current [status](/api-reference/payout-requests/overview#status-values) |
  | `amount` | number | Payout amount |
  | `amount_units` | string | Payout currency, in lowercase |
  | `payout_gateway` | string | `paypal`, `wise`, `crypto` or `venmo` |
  | `created_by` | string | Where the request came from (`api`, `partner`, `automated_partner_payouts` and so on) |
  | `created_at` | string | ISO 8601 timestamp |
  | `updated_at` | string | ISO 8601 timestamp |
</Accordion>

<Accordion title="Pagination — links, meta">
  | Field | Type | Description |
  | - | - | - |
  | `links.first` | string | URL to the first page |
  | `links.last` | string\|null | Always `null` (no total count) |
  | `links.prev` | string\|null | URL to the previous page |
  | `links.next` | string\|null | URL to the next page |
  | `meta.current_page` | integer | Current page number |
  | `meta.from` | integer | First item number on this page |
  | `meta.per_page` | integer | Items per page |
  | `meta.to` | integer | Last item number on this page |
  | `meta.path` | string | Base URL for the endpoint |
</Accordion>

## Search payout requests

Use the search endpoint to filter payout requests by partner, status or currency:

```
GET https://api.partnero.com/v1/payout_requests:search
```

It accepts the same `limit`, `page` and `sort` parameters as the list endpoint, plus these filters. When you combine filters, only payout requests matching all of them are returned.

| Parameter | Type | Description |
| - | - | - |
| `partner_id` | string | Partner ID |
| `partner_key` | string | Any referral key belonging to the partner |
| `partner_email` | string | Partner's email address |
| `status` | string | One of the [status values](/api-reference/payout-requests/overview#status-values) |
| `amount_units` | string | Currency code (case-insensitive) |

<CodeGroup>
  ```bash cURL (pending requests of a partner) theme={null}
  curl --location 'https://api.partnero.com/v1/payout_requests:search?partner_id=partner_123&status=requested' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer YOUR_API_KEY'
  ```

  ```bash cURL (by email and currency) theme={null}
  curl --location 'https://api.partnero.com/v1/payout_requests:search?partner_email=partner@example.com&amount_units=usd' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer YOUR_API_KEY'
  ```
</CodeGroup>

The response has the same format as the list endpoint. Archived partners are included in the search, so you can still find their payout history. If no partner matches the partner filter, the result is an empty list.

## Error responses

| Status | Error | Solution |
| - | - | - |
| 422 | Validation error | Check `limit` (10-100), `sort` (`asc` or `desc`) and that `status` is a valid status value |