# List rewards

List all of your bounty rewards, or the rewards for a specific bounty.

<Aside type="note">
These reward reads use your private key (`nexus_sk_...`), sent in the `X-SHARED-SECRET` header.
</Aside>

List all of your bounty rewards:

<ApiMethod method="GET" path="/rewards" />
<LinkCard title="View full reference" description="Parameters, responses, and status codes." href="/api/bounties/operations/getallbountyrewards/" />

```shell
curl -X 'GET' \
  'https://api.nexus.gg/v1/bounties/rewards' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -H 'X-SHARED-SECRET: nexus_sk_your_key_here'
```

The status should be `200 OK` with a JSON response body that looks something like this:

```json
{
  "groupId": "CsRKC8uD0NLtyQ0LOt8Ru",
  "groupName": "Test Group",
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 1,
  "rewards": [
    {
      "id": "kCxr7lst7Ghk8n1o6DKEF",
      "bountyId": "XrEeF3CrtiSuz2xu8Y6O1",
      "memberId": "9jd7RBR_B2BZ0uWO3_lgv",
      "playerId": "55d57cffaa074cc6b8d332f5d77661f2",
      "name": "200 IGC",
      "externalId": "dalfjka;sdlgjkda;l",
      "rewardCompleted": false
    }
  ]
}
```

You can also retrieve rewards for a specific bounty:

<ApiMethod method="GET" path="/{bountyId}/rewards" />
<LinkCard title="View full reference" description="Parameters, responses, and status codes." href="/api/bounties/operations/getbountyrewards/" />

```shell
curl -X 'GET' \
  'https://api.nexus.gg/v1/bounties/XrEeF3CrtiSuz2xu8Y6O1/rewards' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -H 'X-SHARED-SECRET: nexus_sk_your_key_here'
```

The status should be `200 OK` with a JSON response body that looks something like this:

```json
{
  "groupId": "CsRKC8uD0NLtyQ0LOt8Ru",
  "groupName": "Test Group",
  "bountyId": "XrEeF3CrtiSuz2xu8Y6O1",
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 1,
  "rewards": [
    {
      "id": "kCxr7lst7Ghk8n1o6DKEF",
      "memberId": "9jd7RBR_B2BZ0uWO3_lgv",
      "playerId": "55d57cffaa074cc6b8d332f5d77661f2",
      "name": "200 IGC",
      "externalId": "dalfjka;sdlgjkda;l",
      "rewardCompleted": false
    }
  ]
}
```

By default, neither of these endpoints will return rewards that have already been marked as completed, but you can change this behavior by adding `?includeCompleted` to the URL. Completed rewards will also include the `referenceId`, if one was provided when the reward was marked complete.

```json
{
  "groupId": "CsRKC8uD0NLtyQ0LOt8Ru",
  "groupName": "Test Group",
  "bountyId": "XrEeF3CrtiSuz2xu8Y6O1",
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 1,
  "rewards": [
    {
      "id": "kCxr7lst7Ghk8n1o6DKEF",
      "memberId": "9jd7RBR_B2BZ0uWO3_lgv",
      "playerId": "55d57cffaa074cc6b8d332f5d77661f2",
      "name": "200 IGC",
      "externalId": "dalfjka;sdlgjkda;l",
      "rewardCompleted": true,
      "referenceId": "ababslfdpie"
    }
  ]
}
```