> ## 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 rewards

> List partner commissions with their payout status: in review, available, paid and more

## Endpoint

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

> [!NOTE]
>
> Affiliate programs only. In newsletter and refer-a-friend programs this endpoint returns `428`.

Returns your program's rewards, newest first. Rewards of refunded or archived transactions aren't included.

## Query parameters

| Parameter | Type | Default | Description |
| - | - | - | - |
| `limit` | integer | 10 | Number of results per page (10-100) |
| `page` | integer | 1 | Page number for pagination |
| `payout_status` | string or array | — | Only return rewards in these [payout statuses](https://docs.partnero.com/api-reference/rewards/overview.md#payout-statuses). Pass one value, e.g. `payout_status=in_review`, or several as an array, e.g. `payout_status[]=available&payout_status[]=paid`. Comma-separated values aren't accepted |
| `partner` | string | — | Filter by the ID of the partner who earned the reward |
| `customer` | string | — | Filter by the referred customer's key |
| `transaction` | string | — | Filter by transaction key |

## Request

```bash Commissions in review theme={"system"}
curl --location 'https://api.partnero.com/v1/rewards?payout_status=in_review&limit=50' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

```bash Unpaid balance of one partner theme={"system"}
curl --location 'https://api.partnero.com/v1/rewards?payout_status=available&partner=partner_123' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

```bash Available or paid theme={"system"}
curl --location --globoff 'https://api.partnero.com/v1/rewards?payout_status[]=available&payout_status[]=paid' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

```bash Rewards of one transaction theme={"system"}
curl --location 'https://api.partnero.com/v1/rewards?transaction=invoice_1001' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Response

```json 200 OK theme={"system"}
{
  "data": [
    {
      "id": "rwd_01jcx7m4q9v2k8t5r3n6w0ha1b",
      "key": "invoice_1001",
      "action": "sale",
      "status": "review_period",
      "customer": "customer_123",
      "partner": "partner_123",
      "amount": 200.0,
      "amount_units": "USD",
      "is_currency": true,
      "credit": false,
      "created_at": "2026-11-12T09:30:00.000000Z",
      "deleted_at": null,
      "product_type_data": [],
      "paid": false,
      "payout_status": "in_review",
      "transaction": "invoice_1001"
    },
    {
      "id": "rwd_01j9f2d6s8b4y7e3p5c0g1x2zk",
      "key": "invoice_0987",
      "action": "sale",
      "status": "ok",
      "customer": "customer_456",
      "partner": "partner_123",
      "amount": 49.5,
      "amount_units": "USD",
      "is_currency": true,
      "credit": false,
      "created_at": "2026-10-02T14:05:11.000000Z",
      "deleted_at": null,
      "product_type_data": [],
      "paid": true,
      "payout_status": "paid",
      "transaction": "invoice_0987"
    }
  ],
  "links": {
    "first": "https://api.partnero.com/v1/rewards?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://api.partnero.com/v1/rewards",
    "per_page": 10,
    "to": 2
  },
  "status": 1
}
```

### Response fields

> [accordion] Rewards — data\[]
>
> | Field | Type | Description |
> | - | - | - |
> | `id` | string | The reward's unique ID, e.g. `rwd_01jcx7m4q9v2k8t5r3n6w0ha1b`. Use it with [Get](https://docs.partnero.com/api-reference/rewards/get.md), [Approve](https://docs.partnero.com/api-reference/rewards/approve.md) and [Decline reward](https://docs.partnero.com/api-reference/rewards/decline.md) |
> | `key` | string | Key of the transaction or action that created the reward. Not unique: several rewards can share it |
> | `action` | string | What triggered the reward, e.g. `sale` or `manual_reward` |
> | `status` | string | Internal reward status, e.g. `ok`, `review_period`, `declined`, `rejected` |
> | `payout_status` | string | Where the reward stands for the partner. See [payout statuses](https://docs.partnero.com/api-reference/rewards/overview.md#payout-statuses) |
> | `paid` | boolean | Whether the reward has been paid out |
> | `partner` | string\|null | ID of the partner who earned the reward. Not present on rewards from sub-partners |
> | `customer` | string\|null | The referred customer's key. On rewards from sub-partners, the ID of the partner who earned the reward. See [Rewards from sub-partners](https://docs.partnero.com/api-reference/rewards/overview.md#rewards-from-sub-partners) |
> | `referred_customer` | string | Only on rewards from sub-partners: the ID of the sub-partner who made the sale |
> | `transaction` | string\|null | Key of the transaction the reward came from. `null` for manual rewards |
> | `amount` | number | Reward amount |
> | `amount_units` | string | Currency code, or the reward unit for non-monetary rewards |
> | `is_currency` | boolean | Whether the amount is monetary |
> | `credit` | boolean | Whether the reward is store credit |
> | `product_type_data` | object | Product ID and type, for product-based commissions |
> | `created_at` | string | ISO 8601 timestamp |
> | `deleted_at` | string\|null | Deletion timestamp, if any |

> [accordion] Pagination — links, meta
>
> | Field | Type | Description |
> | - | - | - |
> | `links.first` | string | URL to the first page |
> | `links.last` | string\|null | Always `null` |
> | `links.prev` | string\|null | URL to the previous page |
> | `links.next` | string\|null | URL to the next page. `null` on the last 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 |

## Error responses

| Status | Error | Solution |
| - | - | - |
| 401 | Unauthenticated | Check your API key is set in the `Authorization` header |
| 422 | The payout\_status must be one or more of: ... | Use only the listed payout status values, as a single value or an array. Comma-separated values aren't accepted |
| 428 | Rewards are not valid for this program type. They are only available for affiliate programs. | Use an API key of an affiliate program |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.