Get member by ID

Resolves a group member from the Nexus account’s own id rather than from a code. The initial lookup only checks that some approved NexusNode exists for that Nexus uuid; group membership is enforced afterward by joining on attributionGroupMembers.nexusId, so an approved Nexus that isn’t (or is no longer) a member of the resolved group still returns 400 with code: CodeNotInGroup, not the 404 this operation’s spec entry documents. As with the code lookup, 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

memberId

required

string

Example

CsRKC8uD0NLtyQ0LOt8Ru

The member’s Nexus id - the same id value returned by getMembers and the other member-lookup responses (getMemberByCode, getMemberByPlayerId). Not a code.

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 id

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/id/{memberId}

const url = 'https://api.nexus.gg/v1/manage/members/id/CsRKC8uD0NLtyQ0LOt8Ru?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/id/CsRKC8uD0NLtyQ0LOt8Ru?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
    }
  ]
}