List rev shares

Returns one page of the scheduled revenue-share overrides for a creator group, most recent startDate first.

Each entry’s status tells you whether it is Active, Scheduled (starts in the future), or Ended (already finished). This is computed against the current time on every call, not stored on the row.

A schedule can carry a flat group-wide revShare, a set of per-tier overrides in tierRevenueShares, or both. If a schedule only has tier overrides, its top-level revShare in the response is not 0 or absent, it falls back to the group’s normal, non-scheduled default. Do not read a non-zero revShare here as proof a group-wide override is active for that schedule.

A page below 1 or an unparsable pageSize return 400.

If your API key is scoped to a single program, that key’s group is always used regardless of the groupId you pass.

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 schedules 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

Page of records to return

pageSize

integer format: int32

>= 1 <= 100

Example

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

Responses

200

List of scheduled rev shares for the specified group

application/json

object

groupId

string

groupName

string

currentPage

integer format: int32

currentPageSize

integer format: int32

totalCount

Total number of scheduled revenue shares for this group, not just this page.

integer format: int32

scheduledRevShares

Array

object

string

revShare

Group-wide revenue-share percentage for this schedule’s window (25 means 25%). Falls back to the group’s normal, non-scheduled default when the schedule only carries tier-specific overrides.

number

startDate

string format: date-time

endDate

string format: date-time

groupId

string

groupName

string

tierRevenueShares

Array<object>

object

revShare

number

tierId

string

tierName

string

status

Ended once endDate has passed, Scheduled while startDate is still in the future, otherwise Active.

string

400

Bad input parameter

GET

/manage/scheduled-rev-shares

const url = 'https://api.nexus.gg/v1/manage/scheduled-rev-shares?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/scheduled-rev-shares?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,
  "scheduledRevShares": [
    {
      "id": "2ixlNNFdJh-9scoXek80w",
      "revShare": 25,
      "startDate": "2026-03-13T17:32:28Z",
      "endDate": "2026-03-20T17:32:28Z",
      "groupId": "V1StGXR8_Z5jdHi6B1LiO",
      "groupName": "Aurora Drift Creators",
      "tierRevenueShares": [
        {
          "revShare": 30,
          "tierId": "mK4pQ2xR9vLtN0bWdZ7yA",
          "tierName": "Silver"
        }
      ],
      "status": "Active"
    }
  ]
}