Member bounties by player

Same lookup as getMemberBountiesByID and getMemberBountiesBySlug, addressed by the playerId you assigned the member, matched against their membership in the resolved creator group.

A playerId with no matching membership in that group returns 404 CodeNotInGroup.

Authorizations

X-SHARED-SECRET

required

stringheader

Parameters

Path Parameters

playerId

required

string

Example

player_8f2c41d0

Your externalRef for the member, the id you supplied when generating their code or linking their Nexus account.

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 of records to return

pageSize

integer format: int32

default: 100 >= 1 <= 100

Maximum number of records to return

Responses

200

Bounty progress for specified member

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 progress records

integer format: int32

memberId

The member’s Nexus id.

string

playerId

Echoes the externalRef for this member in the resolved group.

string

progress

Array<object>

object

string

completed

Whether the creator has completed this bounty. Bounties will not be considered completed until the completion limit has been reached

boolean

completionCount

number

lastProgressCheck

string format: date-time

currentObjectiveGroupId

string

currentObjectives

Array<object>

object

string

completed

boolean

count

number

objective

object

string

name

string

count

number

condition

string

Allowed values: AND OR

completedObjectives

Array<object>

object

objectiveGroupId

string

objectives

Array<object>

object

string

completed

boolean

count

number

objective

object

string

name

string

count

number

condition

string

Allowed values: AND OR

rewards

Array<object>

object

The bounty progress reward’s id.

string

name

The bounty reward’s name.

string

externalId

Your own catalog id for this reward.

string

rewardCompleted

Whether this reward has been completed. Becomes true the first time this endpoint successfully completes it, and does not change on later calls.

boolean

rewardReferenceId

The referenceId from the first completion call. Not changed by a later call to this endpoint.

string

member

object

string

playerId

Unique identifier for this member’s in-game user, set when linking with their Nexus account or generating the code

string

name

string

codes

Array<object>

A group member’s code which is used as their storefront URL and when creating transactions or referrals

object

code

string

isPrimary

Indicates whether or not this is the primary code for this member.

boolean

isGenerated

Indicates whether or not this is a code that you generated.

boolean

isManaged

Indicates whether or not this is a code that you manage. Once a code that you generated has been linked to a Nexus account, it will no longer be considered managed.

boolean

400

Bad request

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

/member/playerId/{playerId}

const url = 'https://api.nexus.gg/v1/bounties/member/playerId/player_8f2c41d0?groupId=V1StGXR8_Z5jdHi6B1LiO&page=1&pageSize=100';
const options = {method: 'GET', headers: {'X-SHARED-SECRET': 'nexus_pk_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/member/playerId/player_8f2c41d0?groupId=V1StGXR8_Z5jdHi6B1LiO&page=1&pageSize=100' \
  --header 'X-SHARED-SECRET: nexus_pk_your_key_here'

Example

{
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 1,
  "memberId": "CsRKC8uD0NLtyQ0LOt8Ru",
  "playerId": "player_8f2c41d0",
  "progress": "- id: Hd6zrUid8ulc0boV5Z5ws\n  completed: false\n  completionCount: 1\n  currentObjectiveGroupId: 4Qh1z9nS0mQY0vHqPbT3d\n  currentObjectives:\n    - id: T4h8O0p2aOakYG0WhBTEN\n      completed: false\n      count: 1\n      objective:\n        id: m-OWRxs8qnSSny4THjT1R\n        name: Refer a player that reaches level 20\n        count: 5\n        condition: AND\n  completedObjectives: []\n  bounty:\n    id: 2ixlNNFdJh-9scoXek80w\n    name: Refer 5 players that reach level 20\n    limit: 5\n  member:\n    id: CsRKC8uD0NLtyQ0LOt8Ru\n    playerId: player_8f2c41d0\n    name: Popcorn Frog\n    codes:\n      - code: popcornfrog\n        isPrimary: true\n        isGenerated: false\n        isManaged: false"
}

Example

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