List members

Returns one page of the creators in a creator group, along with the group’s default revenue share and code TTL.

Only active, visible members are returned. Paging starts at page 1 and returns 100 members per page unless you pass page or pageSize. Use totalCount to work out how many pages there are.

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

Query Parameters

page

integer format: int32

>= 1 <= 9999

Page of records to return

pageSize

integer format: int32

>= 1 <= 100

Maximum number of records to return

groupId

string

Group to return members from.

Responses

200

One page of the group’s members, with the group’s own settings alongside them. totalCount is the size of the whole result set, not of this page.

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

currentPage

integer format: int32

currentPageSize

integer format: int32

totalCount

Total number of referrals

integer format: int32

members

Array<object>

object

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

400

groupId did not match a creator group on your publisher account.

GET

/manage/members

curl --request GET \
  --url 'https://api.nexus.gg/v1/manage/members?page=1&pageSize=100' \
  --header 'X-SHARED-SECRET: nexus_pk_your_key_here'

const url = new URL('https://api.nexus.gg/v1/manage/members');
url.searchParams.set('page', '1');
url.searchParams.set('pageSize', '100');

const response = await fetch(url, {
  headers: { 'X-SHARED-SECRET': process.env.NEXUS_PUBLIC_KEY },
});

const { members, totalCount } = await response.json();

Example

{
  "groupId": "V1StGXR8_Z5jdHi6B1LiO",
  "groupName": "Aurora Drift Creators",
  "groupDefaultRevShare": 10,
  "codeTTLInDays": 90,
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 15,
  "members": [
    {
      "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
        }
      ]
    }
  ]
}