List groups

Lists the creator groups your API key can use, each with its id, name, and default flag. A publisher-wide key lists every group on your publisher account; a key assigned to one group lists only that group.

The response is not paginated: every group comes back in one call, regardless of how many there are.

This endpoint takes no groupId parameter.

A group’s id here is the same value other endpoints call groupId, use it there when your program runs more than one creator group.

NOTE: This method uses a secret (nexus_sk_...) API key and should never be called from or embedded into the gaming client. These routes should ONLY be accessed from your back-end services.

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.

Responses

200

The creator groups your API key can use. There is no paging: all groups come back in a single call.

application/json

object

groups

Array<object>

object

name

string

isDefault

Specifies whether this is the default group for your creator program. The default group will be used in all API requests unless a groupId query parameter is specified

boolean

400

Bad input parameter

GET

/manage/groups

const url = 'https://api.nexus.gg/v1/manage/groups';
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/groups \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here'

Example

{
  "groups": [
    {
      "name": "Aurora Drift Creators",
      "id": "V1StGXR8_Z5jdHi6B1LiO",
      "isDefault": true
    }
  ]
}