Get member by player ID

Resolves a group member by matching your playerId directly against attributionGroupMembers.externalRef. Unlike the code and ID lookups, this operation needs no separate NexusNode lookup step: the playerId branch filters the member query directly instead of running the separate node query the code and ID lookups use. It still requires the resolved member’s Nexus to have at least one linked node; the handler rejects a match whose nexus.nexusNodes array comes back empty. A playerId with no qualifying member in the resolved group returns 400 with code: CodeNotInGroup, not the 404 this operation’s spec entry documents. As with the other lookups, an unresolvable groupId returns 400 with code: InvalidGroup first.

Authorizations

X-SHARED-SECRET

required

stringheader

Send your public API key (nexus_pk_...) in the X-SHARED-SECRET header. Generate one in the Publisher Dashboard.

Parameters

Path Parameters

playerId

required

string

Example

player_8f2c41d0

Member player id. This is your internal unique identifier that was used to create this code or when linking to a Nexus.

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.

Responses

200

Member object for given playerId

application/json

object

groupId

ID of the creator group

string

groupName

Name of the creator group

string

groupDefaultRevShare

Default revenue share percent for the creator group

number

codeTTLInDays

How long a creator code stays attached to a player after use, in days. Omitted when the group’s codes do not expire.

number

tier

The member’s tier in the creator group. Omitted when the member has no tier.

object

string

name

string

revShare

The member’s revenue share percent from this tier (20 means 20%).

number

mappedSkuIds

Your SKU ids mapped to this member in the creator group. Omitted when no SKUs are mapped.

Array<string>

string

name

string

playerId

Your unique identifier for this user or player, provided when the code was created or when an existing nexus was linked to one of your user accounts

string

playerMetadata

Additional player information to be applied to this member (such as their in game display name)

object

displayName

The players in game display name

string

logoImage

string

profileImage

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

YouTube

URL of the member’s YouTube channel, or an empty string.

string

YouTube_AVV

Average views per YouTube video, as a numeric string, or an empty string.

string

Twitch

URL of the member’s Twitch channel, or an empty string.

string

Twitch_CCV

Average concurrent viewers on Twitch, as a numeric string, or an empty string.

string

TikTok

URL of the member’s TikTok account, or an empty string.

string

TikTok_AVV

Average views per TikTok video, as a numeric string, or an empty string.

string

404

Not found

GET

/manage/members/player/{playerId}

const url = 'https://api.nexus.gg/v1/manage/members/player/player_8f2c41d0?groupId=V1StGXR8_Z5jdHi6B1LiO';
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/manage/members/player/player_8f2c41d0?groupId=V1StGXR8_Z5jdHi6B1LiO' \
  --header 'X-SHARED-SECRET: nexus_pk_your_key_here'

Example

{
  "groupId": "V1StGXR8_Z5jdHi6B1LiO",
  "groupName": "Aurora Drift Creators",
  "groupDefaultRevShare": 10,
  "codeTTLInDays": 90,
  "tier": {
    "id": "mK4pQ2xR9vLtN0bWdZ7yA",
    "name": "Silver",
    "revShare": 20
  },
  "mappedSkuIds": [
    "Hv98bvRCSm1jDDPhls1qC"
  ],
  "id": "CsRKC8uD0NLtyQ0LOt8Ru",
  "name": "samzorz",
  "playerId": "player_8f2c41d0",
  "playerMetadata": {
    "displayName": "Popcorn Frog"
  },
  "logoImage": "https://cdn.nexus.gg/CsRKC8uD0NLtyQ0LOt8Ru/images/logo-image.jpg",
  "profileImage": "https://cdn.nexus.gg/CsRKC8uD0NLtyQ0LOt8Ru/images/profile-image.jpg",
  "codes": [
    {
      "code": "samzorz",
      "isPrimary": true,
      "isGenerated": false,
      "isManaged": false
    }
  ],
  "YouTube": "https://www.youtube.com/@samzorz",
  "YouTube_AVV": "15400",
  "Twitch": "https://www.twitch.tv/samzorz",
  "Twitch_CCV": "320",
  "TikTok": "https://www.tiktok.com/@samzorz",
  "TikTok_AVV": "8200"
}