---
title: "List all rewards"
method: GET
path: "/v2/rewards"
tags: ["Rewards"]
---

# List all rewards

`GET /v2/rewards`

Returns a list of your rewards. The rewards are returned sorted by creation date by default, with the most recent rewards appearing first.

## Query parameters

- `company_key` string
- `payment_status` 'in_transit' | 'withdrawn' | 'available' | 'paid_externally' | 'expired' | 'failed' | 'merging'
- `max_created` integer
- `min_created` integer
- `order_by` '-created_at' | 'created_at' | '-amount' | 'amount' | '-ready_at' | 'ready_at'
- `group_key` string
- `customer_key` string
- `invoice_key` string
- `status` string
- `exclude_drip_rewards` string
- `hide_archived_rewards` boolean
- `empty_line_id` boolean
- `keywords` string
- `description` string
- `distinct_description` boolean
- `distinct_decline_reason` boolean
- `decline_reason` string
- `invoiceable` boolean
- `currency` string
- `limit` integer
- `starting_after` string
- `ending_before` string

## Response `200`

Returns a list of your rewards. The rewards are returned sorted by creation date by default, with the most recent rewards appearing first.

- object
  - `data` object, required
    - `has_more` boolean
    - `items` object[]
      - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation
      - `key` string — A unique identifier used to reference the object
      - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update
      - `amount` integer, nullable — The amount of the reward in cents (USD).
      - `currency` string, nullable — The currency of the reward.
      - `decline_reason` string, nullable — The reason the reward has been held or declined
      - `description` string, nullable — The description that the company gives to the reward.
      - `reward_status` string, nullable — The status of the reward. Can be one of: `hold`, `pending`, `approved`, `declined`, `paid`.
      - `company` object
        - `id` integer — Unique id of this company.
        - `key` string — Unique key of this company.
        - `name` string — The name of this company.
      - `customer` object, nullable
        - `created_at` integer, nullable — Immutable Unix timestamp in milliseconds taken at time of customer creation
        - `email` string, nullable — The email of the customer.
        - `key` string, nullable — Unique key of this customer.
        - `name` string, nullable — The name of the customer.
        - `sub_ids` string[], nullable
        - `updated_at` integer, nullable — Immutable Unix timestamp in milliseconds taken at time of customer last update
      - `partnership_key` string, nullable — Unique key of this partnership.
      - `payment_date` integer, nullable — The epoch timestamp (ms) for when the partner should be able to cash out the reward. Can be null when the reward is declined.
      - `payment_status` string, nullable — This status indicates whether the partner can withdraw the reward. Can be one of: `pending`, `available`, `withdrawn`, or `paid_externally`. Can be null when the payment is declined.
      - `payout_id` integer, nullable — The unique Id of the payout this reward is associted with.
      - `source` object, nullable
        - `key` string — The key of the source that generated this reward.
        - `type` string, nullable — The source that generated this reward. Can be one of: `transaction`, `lead`, `deal`, `submission`, `action`, `bill`, `asset`, `order_item`, `request`, `bonus`.
      - `transaction` object, nullable
        - `amount` integer, nullable — Transaction amount in cents for specified currency.
        - `amount_usd` integer, nullable — Transaction amount in cents converted to USD.
        - `archived` boolean — The boolean flag which determines if the transaction is archived or not
        - `category_key` string, nullable — Key of transaction category.
        - `created_at` integer, nullable — Immutable Unix timestamp in milliseconds taken at time of creation
        - `currency` string, nullable — Transaction currency type.
        - `product_key` string, nullable — Key of transaction product.
        - `updated_at` integer, nullable — Unix timestamp in milliseconds taken at time of last update
      - `withdrawn` boolean — The boolean flag which determines if the reward has been withdrawn already in some payout
    - `total` integer, nullable
  - `message` string, required
  - `status` integer, required

## Other responses

- `400` — Bad Request Error
- `401` — Unauthorized Error
- `403` — Forbidden Error
- `404` — Not Found Error
- `500` — Internal Server Error

---

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