List 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

required

stringheader

Parameters

Query Parameters

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

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 format: int32

default: 1 >= 1 <= 9999

Page number.

pageSize

integer format: int32

default: 100 >= 1 <= 100

Records per page.

includeCompleted

string

default: false

Example

true

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

application/json

object

groupId

ID of the creator group

string

groupName

Name of the creator group

string

currentPage

Page number of response records returned

integer format: int32

currentPageSize

Page size used for this operation

integer format: int32

totalCount

Total number of referrals

integer format: int32

rewards

Array<object>

object

The bounty progress reward’s id, usable as the rewardId path parameter to completeReward.

string

bountyId

The bounty this reward belongs to.

string

memberId

The member this reward is owed to.

string

playerId

Present only when the member has a membership in this group; omitted otherwise.

string

name

string

externalId

Your catalog id for this reward.

string

rewardCompleted

boolean

rewardReferenceId

string

404

Bounty Reward not found

application/json

object

code

CodeNotInGroup: Creator group is private, and specified code is not linked to it
InvalidGroup: No creator group was found with the specified groupId
InvalidAuthCode: AuthCode provided is not valid
ExpiredAuthCode: AuchCode provided has expired
ReferralNexusNotFound: No Nexus was found to match the provided referral code
BountyNotFound: No bounty was found with the specified bountyId
CreatorNotFound: No creator found with the specified creatorId
InvalidEventCode: No event found with the specifed event code

string

Allowed values: InvalidGroup CodeNotInGroup InvalidAuthCode ExpiredAuthCode ReferralNexusNotFound BountyNotFound MemberNotFound InvalidEventCode UnknownError

message

string

GET

/rewards

const url = 'https://api.nexus.gg/v1/bounties/rewards?groupId=V1StGXR8_Z5jdHi6B1LiO&page=1&pageSize=100&includeCompleted=false';
const options = {method: 'GET', headers: {'X-SHARED-SECRET': 'nexus_sk_your_key_here'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.nexus.gg/v1/bounties/rewards?groupId=V1StGXR8_Z5jdHi6B1LiO&page=1&pageSize=100&includeCompleted=false' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here'

Example

{
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 1,
  "rewards": [
    {
      "id": "2ixlNNFdJh-9scoXek80w",
      "bountyId": "2ixlNNFdJh-9scoXek80w",
      "memberId": "CsRKC8uD0NLtyQ0LOt8Ru",
      "playerId": "player_8f2c41d0",
      "name": "In-Game Title",
      "externalId": "reward_mvp_title",
      "rewardCompleted": false,
      "rewardReferenceId": "ref_8f2c41d0"
    }
  ]
}

Example

{
  "code": "InvalidGroup",
  "message": "Bounty Not found"
}