Get Workspace Info

GET /api/workspace

Returns sanitized workspace info, the current month's usage counters, and plan limits. Useful for dashboards, health checks, and quota monitoring.

This endpoint never returns email, clerkId, billing details, or any other internal field. Only the whitelisted fields shown below are exposed.

Headers

Prop

Type

Request

No body or query parameters.

curl https://api.rankgun.works/api/workspace \
  -H "x-api-key: YOUR_API_KEY"

Response

200 OK

{
  "success": true,
  "workspace": {
    "id": "j97abc...",
    "name": "Acme Clan",
    "slug": "acme-clan",
    "groupId": 1234567,
    "groupName": "Acme",
    "groupIconUrl": "https://tr.rbxcdn.com/...",
    "tier": "elite",
    "isActive": true,
    "createdAt": 1712000000
  },
  "usage": {
    "ranksThisMonth": 412,
    "ranksToday": 11,
    "lastRankAt": 1712345678,
    "usageResetAt": 1714521600
  },
  "limits": {
    "maxRanksPerMonth": 20000,
    "maxAdmins": 10,
    "maxManagers": 20,
    "maxTrackedPlayers": 500
  }
}