List Ranks

Lists a department's ranks, top rank first.

GET

/api/v1/server/departments/{departmentId}/ranks

Request

curl -X GET "https://api.melonly.com/api/v1/server/departments/{departmentId}/ranks" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Success

{
  "data": [
    {
      "colour": "#11d982",
      "departmentId": "7392336585590575104",
      "id": "7392336600000000000",
      "name": "Deputy Deputy",
      "permissions": "0",
      "position": 3
    }
  ],
  "page": 1,
  "pageSize": 10,
  "total": 1,
  "totalPages": 1
}

You can order by position (default) or id.

Authorization

Authorizationstringrequired
Your API token as Bearer YOUR_TOKEN. Create one in your server's dashboard settings.

Path parameters

departmentIdstringrequired

Query parameters

pageintegerdefault: 1
1-based page number. Defaults to 1.
pageSizeintegerdefault: 10
Items per page, clamped to 1-100. Defaults to 10.
orderBystring
Field to sort by. See the endpoint description for the accepted values.
sortstring
Sort direction. Defaults to desc.
Allowed values:ascdesc

Response

200 Success. Results are paged and also include page, pageSize, total and totalPages.

departmentIdstringrequired
Department ID.
idstringrequired
Unique ID.
namestringrequired
Rank name.
permissionsstringrequired
Rank permission bitfield as a decimal string.
positionintegerrequired
Order in the list. Lower comes first.
colourstring | null
Hex colour.
linkedDiscordRoleIdstring | null
Discord role kept in sync with this one.

Errors

StatusMeaning
400Invalid request. validation_failed lists each invalid field in details.fields.
401Missing, invalid or expired token
404Not found
429Rate limited. See Retry-After and details.
500Internal server error