# List rewards

`GET https://api.nexus.gg/v1/bounties/rewards`

Lists a creator group's undelivered External bounty rewards, the ones you fulfill yourself outside Nexus rather than Nexus paying out automatically. getBountyRewards is the identical listing scoped to a single bounty; both operations are served by the same handler, differing only in whether a bounty id is present in the path.

Only rewards of type External are ever returned here. By default only rewards not yet marked complete are returned; passing `includeCompleted` with any value, including `false`, includes completed ones too.

## Authorizations

- `X-SHARED-SECRET` (string, header, required)

## Query parameters

- `groupId` (string) - Creator group to use for this operation. If your key is scoped to a single program, that group is always used regardless of this value; otherwise falls back to your default group when omitted.
- `page` (integer) - Page number.
- `pageSize` (integer) - Records per page.
- `includeCompleted` (string) - Include already-completed rewards in the list. Presence of this parameter, with any value including `false`, includes them; omit it entirely to get only undelivered rewards.

## Responses

### 200

Rewards successfully retrieved

#### Body (`application/json`)

- `groupId` (string) - ID of the creator group
- `groupName` (string) - Name of the creator group
- `currentPage` (integer) - Page number of response records returned
- `currentPageSize` (integer) - Page size used for this operation
- `totalCount` (integer) - Total number of referrals
- `rewards` (array of object)

### 404

Bounty Reward not found

#### Body (`application/json`)

- `code` (string) - CodeNotInGroup: Creator group is private, and specified code is not linked to it<br/> InvalidGroup: No creator group was found with the specified groupId<br/> InvalidAuthCode: AuthCode provided is not valid<br/> ExpiredAuthCode: AuchCode provided has expired<br/> ReferralNexusNotFound: No Nexus was found to match the provided referral code<br/> BountyNotFound: No bounty was found with the specified bountyId<br/> CreatorNotFound: No creator found with the specified creatorId<br/> InvalidEventCode: No event found with the specifed event code Allowed values: InvalidGroup, CodeNotInGroup, InvalidAuthCode, ExpiredAuthCode, ReferralNexusNotFound, BountyNotFound, MemberNotFound, InvalidEventCode, UnknownError.
- `message` (string)