Rosters | ClashPerk Docs

get

/rosters/{guildId}/list

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

guildIdstringRequired

Responses

200Success

application/json

500Error

application/json

get

/rosters/{guildId}/list

GET /v1/rosters/{guildId}/list HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rosters": [
    {
      "_id": "text",
      "category": "text",
      "name": "text",
      "guildId": "text",
      "maxMembers": 1,
      "minTownHall": 1,
      "maxTownHall": 1,
      "minHeroLevels": 1,
      "roleId": "text",
      "colorCode": 1,
      "clan": {
        "tag": "text",
        "name": "text",
        "badgeUrl": "text"
      },
      "members": [
        {
          "warPreference": "text",
          "categoryId": "text",
          "name": "text",
          "tag": "text",
          "userId": "text",
          "username": "text",
          "role": "text",
          "townHallLevel": 1,
          "heroes": {},
          "trophies": 1,
          "clan": {
            "tag": "text",
            "name": "text",
            "alias": "text"
          },
          "createdAt": "2025-12-28T20:00:46.259Z"
        }
      ],
      "layout": "text",
      "sheetId": "text",
      "closed": true,
      "startTime": "2025-12-28T20:00:46.259Z",
      "endTime": "2025-12-28T20:00:46.259Z",
      "sortBy": "text",
      "useClanAlias": true,
      "allowUnlinked": true,
      "allowMultiSignup": true,
      "allowCategorySelection": true,
      "lastUpdated": "2025-12-28T20:00:46.259Z",
      "createdAt": "2025-12-28T20:00:46.259Z"
    }
  ],
  "categories": [
    {
      "_id": "text",
      "displayName": "text",
      "name": "text",
      "guildId": "text",
      "selectable": true,
      "roleId": "text",
      "createdAt": "2025-12-28T20:00:46.259Z"
    }
  ]
}

post

/rosters/{guildId}/create

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

Responses

201Success

500Error

application/json

post

/rosters/{guildId}/create

POST /v1/rosters/{guildId}/create HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

get

/rosters/{guildId}/{rosterId}

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

guildIdstringRequired

Responses

200Success

application/json

500Error

application/json

get

/rosters/{guildId}/{rosterId}

GET /v1/rosters/{guildId}/{rosterId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "category": "text",
  "name": "text",
  "guildId": "text",
  "maxMembers": 1,
  "minTownHall": 1,
  "maxTownHall": 1,
  "minHeroLevels": 1,
  "roleId": "text",
  "colorCode": 1,
  "clan": {
    "tag": "text",
    "name": "text",
    "badgeUrl": "text"
  },
  "members": [
    {
      "warPreference": "text",
      "categoryId": "text",
      "name": "text",
      "tag": "text",
      "userId": "text",
      "username": "text",
      "role": "text",
      "townHallLevel": 1,
      "heroes": {},
      "trophies": 1,
      "clan": {
        "tag": "text",
        "name": "text",
        "alias": "text"
      },
      "createdAt": "2025-12-28T20:00:46.259Z"
    }
  ],
  "layout": "text",
  "sheetId": "text",
  "closed": true,
  "startTime": "2025-12-28T20:00:46.259Z",
  "endTime": "2025-12-28T20:00:46.259Z",
  "sortBy": "text",
  "useClanAlias": true,
  "allowUnlinked": true,
  "allowMultiSignup": true,
  "allowCategorySelection": true,
  "lastUpdated": "2025-12-28T20:00:46.259Z",
  "createdAt": "2025-12-28T20:00:46.259Z"
}

delete

/rosters/{guildId}/{rosterId}

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

Responses

200Success

No content

500Error

application/json

delete

/rosters/{guildId}/{rosterId}

DELETE /v1/rosters/{guildId}/{rosterId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

patch

/rosters/{guildId}/{rosterId}

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

Responses

200Success

No content

500Error

application/json

patch

/rosters/{guildId}/{rosterId}

PATCH /v1/rosters/{guildId}/{rosterId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

post

/rosters/{guildId}/{rosterId}/clone

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

Responses

201Success

500Error

application/json

post

/rosters/{guildId}/{rosterId}/clone

POST /v1/rosters/{guildId}/{rosterId}/clone HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

put

/rosters/{guildId}/{rosterId}/members

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

Responses

200Success

No content

500Error

application/json

put

/rosters/{guildId}/{rosterId}/members

PUT /v1/rosters/{guildId}/{rosterId}/members HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

delete

/rosters/{guildId}/{rosterId}/members

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

guildIdstringRequired

Body

playerTagsstring[] · min: 1Required

Responses

200Success

application/json

Responseobject

500Error

application/json

delete

/rosters/{guildId}/{rosterId}/members

DELETE /v1/rosters/{guildId}/{rosterId}/members HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "playerTags": [
    "text"
  ]
}

{}

post

/rosters/{guildId}/{rosterId}/members/refresh

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

Responses

201Success

500Error

application/json

post

/rosters/{guildId}/{rosterId}/members/refresh

POST /v1/rosters/{guildId}/{rosterId}/members/refresh HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

put

/rosters/{guildId}/{rosterId}/members/transfer

Authorizations

AuthorizationstringRequired

in header (authorization: bearer [token])

Path parameters

rosterIdstringRequired

guildIdstringRequired

Body

playerTagsstring[] · min: 1Required

newRosterIdstringRequired

newGroupIdstringRequired

Responses

200Success

application/json

500Error

application/json

put

/rosters/{guildId}/{rosterId}/members/transfer

PUT /v1/rosters/{guildId}/{rosterId}/members/transfer HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "playerTags": [
    "text"
  ],
  "newRosterId": "text",
  "newGroupId": "text"
}

{
  "roster": {
    "_id": "text",
    "category": "text",
    "name": "text",
    "guildId": "text",
    "maxMembers": 1,
    "minTownHall": 1,
    "maxTownHall": 1,
    "minHeroLevels": 1,
    "roleId": "text",
    "colorCode": 1,
    "clan": {
      "tag": "text",
      "name": "text",
      "badgeUrl": "text"
    },
    "members": [
      {
        "warPreference": "text",
        "categoryId": "text",
        "name": "text",
        "tag": "text",
        "userId": "text",
        "username": "text",
        "role": "text",
        "townHallLevel": 1,
        "heroes": {},
        "trophies": 1,
        "clan": {
          "tag": "text",
          "name": "text",
          "alias": "text"
        },
        "createdAt": "2025-12-28T20:00:46.259Z"
      }
    ],
    "layout": "text",
    "sheetId": "text",
    "closed": true,
    "startTime": "2025-12-28T20:00:46.259Z",
    "endTime": "2025-12-28T20:00:46.259Z",
    "sortBy": "text",
    "useClanAlias": true,
    "allowUnlinked": true,
    "allowMultiSignup": true,
    "allowCategorySelection": true,
    "lastUpdated": "2025-12-28T20:00:46.259Z",
    "createdAt": "2025-12-28T20:00:46.259Z"
  },
  "result": [
    {
      "player": {
        "name": "text",
        "tag": "text"
      },
      "success": true,
      "message": "text"
    }
  ]
}