API v2 · Configuration

Fetch one rank

GET/v2/ranks/{uniqueId}

Last updated 1 October 2026

Overview

Permission scope: ranks.read
Community feature: ranks
Content type: application/json

Authentication

Send Authorization: Bearer YOUR_API_KEY and X-Clan-Id: COMMUNITY_ID. The community API switch and key must be enabled. The key must have the scope shown above. See authentication and key storage.

Parameters

Name	Location	Type	Required	Constraints and description
`uniqueId`	path	`string`	Yes	The rank's Roblox role resource id.

Error responses

Status	When it is returned
400	The request was malformed or failed validation.
401	The API key is missing, malformed, or not recognised for this community.
403

Server-side examples

After HTTP requests are enabled, Roblox Lua uses HttpService:GetSecret() from a server Script, never a LocalScript.

Request

GET

curl --request GET \
  --url 'https://api.clanlabs.co/v2/ranks/900001' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'X-Clan-Id: COMMUNITY_ID'

Response

200

The rank

{
  "data": {
    "uniqueId": 900001,
    "rankId": 10,
    "name": "Private",
    "prefix": "[PVT]",
    "experience": {
      "enabled": true,
      "requirement": 1
    },
    "locked": true,
    "discordRoles": [
      "YOUR_DISCORD_ROLES"
    ],
    "gamepass": {
      "enabled": true,
      "id": "RESOURCE_ID",
      "name": "EXAMPLE_NAME"
    },
    "badge": {
      "enabled": true,
      "id": "RESOURCE_ID",
      "name": "EXAMPLE_NAME"
    },
    "shirt": {
      "enabled": true,
      "id": "RESOURCE_ID",
      "name": "EXAMPLE_NAME",
      "type": "YOUR_TYPE"
    },
    "quota": {
      "enabled": true,
      "points": 1
    },
    "createdAt": 1735689600000,
    "lastUpdatedAt": 1735689600000
  }
}

Fetch one rank | Clan Labs API

OverviewCopy link to overview

AuthenticationCopy link to authentication

ParametersCopy link to parameters

Error responsesCopy link to error responses

Rate limitsCopy link to rate limits

Related endpointsCopy link to related endpoints

Response

Overview

Authentication

Parameters

Error responses

Rate limits

Related endpoints