> For the complete documentation index, see [llms.txt](https://docs.sparkloop.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sparkloop.app/api-v3/endpoints/payouts.md).

# Payouts

## Payouts

A **Payout** is a payment SparkLoop has made (or is preparing to make) to your account for partner-network referral commissions. Payouts are account-scoped; this resource exposes only your account's partner-network payouts — affiliate commissions and other adjustments are not returned, by list or by UUID.

### List payouts

<mark style="color:blue;">`GET`</mark> `https://api.sparkloop.app/v3/payouts`

Paginated, newest first.

**Query Parameters**

| Name   | Type   | Description                                                                                                                       |
| ------ | ------ | --------------------------------------------------------------------------------------------------------------------------------- |
| expand | String | `details` (per-publication breakdown of what this payout pays for), `unpaid_details` (confirmations deferred to a future payout). |

{% tabs %}
{% tab title="200: OK" %}

```json
{
  "payouts": [
    <Payout Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 1,
    "total_payouts": 9
  }
}
```

{% endtab %}
{% endtabs %}

### Get payout

<mark style="color:blue;">`GET`</mark> `https://api.sparkloop.app/v3/payouts/:uuid`

**Path Parameters**

| Name                                   | Type   | Description        |
| -------------------------------------- | ------ | ------------------ |
| uuid<mark style="color:red;">\*</mark> | String | The payout's UUID. |

**Query Parameters**

| Name   | Type   | Description                  |
| ------ | ------ | ---------------------------- |
| expand | String | `details`, `unpaid_details`. |

{% tabs %}
{% tab title="200: OK" %}

```json
{
  "payout": <Payout Object>
}
```

{% endtab %}

{% tab title="404: Not Found" %}

```json
{
  "error": "Resource not found."
}
```

{% endtab %}
{% endtabs %}
