Skip to content

Returns one page of the creators in a creator group, along with the group’s default revenue share. Each member carries its tier, its social channels, the group’s code TTL, and the codes that attribute in this group.

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.

X-SHARED-SECRET
required
stringheader

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

page
integer format: int32
>= 1 <= 9999

Page of records to return

pageSize
integer format: int32
>= 1 <= 1000

Maximum number of members to return. Values above 1000 are capped at 1000.

groupId
string

Group to return members from.

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.

Media typeapplication/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
currentPage
integer format: int32
currentPageSize
integer format: int32
totalCount

Total number of members in the group, not just this page.

integer format: int32
members
Array
object
id
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
tier

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

object
id
string
name
string
revShare

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

number
codeTTLInDays

How long a creator code stays attached to a player after use, in days. Set on the creator group, so it is the same for every member. Omitted when the group’s codes do not expire.

number
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

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'
Example
{
"groupId": "V1StGXR8_Z5jdHi6B1LiO",
"groupName": "Aurora Drift Creators",
"groupDefaultRevShare": 10,
"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
}
],
"tier": {
"id": "mK4pQ2xR9vLtN0bWdZ7yA",
"name": "Silver",
"revShare": 20
},
"codeTTLInDays": 90,
"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"
}
]
}