Get member by code

Resolves a group member from one of their codes and returns the member together with the creator group’s own defaults (groupDefaultRevShare, codeTTLInDays). The match on memberCode is case-insensitive - the query compares the incoming code against LOWER(:code). A code only resolves if it has an approved NexusNode, generated either for this specific creator group or for no group at all; a code a different group generated for itself is invisible here.

The groupId query parameter is not a simple default. If the calling API key already has its own attribution group, that group is always used and any groupId you pass is silently ignored, with no error. The query parameter only takes effect for an API key with no attribution group of its own, and if it is also omitted in that case, the publisher’s default group is used. An unresolvable groupId returns 400 with code: InvalidGroup before the code lookup even runs.

When the code doesn’t match an approved member of the resolved group, the handler returns 400 with code: CodeNotInGroup.

This method authenticates with a public (nexus_pk_...) key.

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

memberCode

required

string

Example

popcornfrog

The creator’s code, matched case-insensitively.

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 code

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

TTL defined for the creator group

number

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

404

Not found

GET

/manage/members/{memberCode}

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

Example

{
  "groupId": "V1StGXR8_Z5jdHi6B1LiO",
  "groupName": "Aurora Drift Creators",
  "groupDefaultRevShare": 10,
  "codeTTLInDays": 90,
  "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
    }
  ]
}