List tiers

Lists a creator group’s revenue-share tiers, one page at a time, with each tier’s current member count alongside its revShare.

This operation and the single-tier lookup below it are the only tier endpoints in this API. There is no way to create, edit, or delete a tier through it.

memberCount only counts members whose attributionGroupTierId is set to this tier, and defaults to 0 for a tier with none. The count has no member-status filter, so it includes members in every status, not just approved ones. It comes from a separate grouped count query, not from the tier row itself.

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

Query Parameters

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

Creator group to list tiers for. 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.

page

integer format: int32

>= 1 <= 9999

Example

Defaults to 1 if omitted.

pageSize

integer format: int32

>= 1 <= 100

Example

Maximum number of records to return. Defaults to 10 if omitted.

Responses

200

List of tiers for the specified group

application/json

object

groupId

string

groupName

string

currentPage

integer format: int32

currentPageSize

integer format: int32

totalCount

Total number of tiers on this group, not just this page.

integer format: int32

groupTiers

Array<object>

object

string

name

string

revShare

This tier’s revenue-share rate as a percentage (20 means 20%).

number

memberCount

number

400

Bad input parameter

GET

/manage/tiers

const url = 'https://api.nexus.gg/v1/manage/tiers?groupId=V1StGXR8_Z5jdHi6B1LiO&page=1&pageSize=10';
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?groupId=V1StGXR8_Z5jdHi6B1LiO&page=1&pageSize=10' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here'

Example

{
  "groupId": "V1StGXR8_Z5jdHi6B1LiO",
  "groupName": "Aurora Drift Creators",
  "currentPage": 1,
  "currentPageSize": 100,
  "totalCount": 3,
  "groupTiers": [
    {
      "id": "2ixlNNFdJh-9scoXek80w",
      "name": "Silver",
      "revShare": 20,
      "memberCount": 12
    }
  ]
}