Get tier

Returns one tier’s detail, including its revShare, together with one page of the group members currently assigned to it.

Only members with status = Approved are included. A pending or removed member assigned to this tier never appears in this list.

Each member’s codes array covers every Nexus node linked to that creator, not just their primary one. Their playerId and playerMetadata echo the member’s stored externalRef and externalMetadata, the same values you supplied when the member was created or later linked to a player.

This tier’s revShare is returned as a fraction here (0.2 for a 20% tier), not the percentage getCreatorGroupTiers returns for the same tier (20).

Authorizations

X-SHARED-SECRET

required

stringheader

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

Parameters

Path Parameters

tierId

required

string

Example

2ixlNNFdJh-9scoXek80w

The tier’s uuid (CreatorGroupTier.uuid).

Query Parameters

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

Creator group the tier belongs to. 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

Creator Group Tier matching the specified id

application/json

object

groupId

string

groupName

string

name

string

revShare

This tier’s revenue-share rate as a fraction (0 to 1), for example 0.2 for 20%. Unlike the tiers list endpoint, this value is not converted to a percentage.

number

currentPage

integer format: int32

currentPageSize

integer format: int32

totalCount

Total number of approved members on this tier, not just this page.

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

404

groupId did not match a creator group on your account, or tierId did not match a tier on that group.

GET

/manage/tiers/{tierId}

const url = 'https://api.nexus.gg/v1/manage/tiers/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO';
const options = {method: 'GET', headers: {'X-SHARED-SECRET': 'nexus_sk_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/tiers/2ixlNNFdJh-9scoXek80w?groupId=V1StGXR8_Z5jdHi6B1LiO' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here'

Example

{
  "groupId": "V1StGXR8_Z5jdHi6B1LiO",
  "groupName": "Aurora Drift Creators",
  "id": "2ixlNNFdJh-9scoXek80w",
  "name": "Silver",
  "revShare": 0.2,
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 2,
  "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
        }
      ]
    }
  ]
}