# List payouts

### Request

<table><thead><tr><th width="145"></th><th></th></tr></thead><tbody><tr><td><code>GET</code></td><td><code>https://api.getrewardful.com/v1/payouts</code></td></tr></tbody></table>

### Optional parameters

<table><thead><tr><th width="202">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>affiliate_id</code></td><td>Show payouts for the specified affiliate.</td></tr><tr><td><code>state</code></td><td><p>Show payouts that are currently in the specified states.</p><p>Valid values are <code>pending</code>, <code>due</code>, <code>processing</code>, and <code>paid</code>.</p><p>You can pass <code>state[]</code> to specify multiple states.</p></td></tr></tbody></table>

### Expandable objects

<table><thead><tr><th width="264">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>affiliate</code></td><td>Include details about the affiliate this payout is associated with.</td></tr><tr><td><code>commissions</code></td><td>Include details about each of the commissions constituting this payout.</td></tr></tbody></table>

### Examples

#### List all payouts

```shell
curl --request GET \
  --url https://api.getrewardful.com/v1/payouts \
  -u YOUR_API_SECRET:
```

#### List all payouts with data for the associated affiliate and commissions

```shell
curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?expand[]=affiliate&expand[]=commissions \
  -u YOUR_API_SECRET:
```

#### List payouts for a specific affiliate

```shell
curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?affiliate_id=5768bd90-7953-493f-ae6c-6562eb4d7e72 \
  -u YOUR_API_SECRET:
```

#### List payouts that have been marked as paid

```shell
curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?state= \
  -u YOUR_API_SECRET:
```

#### List payouts that are either due or pending

```shell
curl --request GET \
  --url https://api.getrewardful.com/v1/payouts?state[]=due&state[]=pending \
  -u YOUR_API_SECRET:
```