modl.gg

Get Role

Retrieve a specific role by ID.

GET /v1/minecraft/roles/{id}

Retrieve full details for a specific role by its ID, including all assigned permissions.

Authentication

Requires the X-API-Key header with your server's API key.

X-API-Key: your-api-key-here

Request

Headers

HeaderTypeRequiredDescription
X-API-KeystringYesYour server's API key.

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the role.
GET /v1/minecraft/roles/role_002

Response

200 OK

{
  "role": {
    "id": "role_002",
    "name": "Admin",
    "order": 2,
    "color": "#FF8800",
    "permissions": [
      "punish",
      "tickets.view",
      "tickets.reply",
      "tickets.manage",
      "reports.view",
      "reports.manage",
      "staff.manage"
    ],
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2024-01-10T08:00:00Z"
  }
}

Error Responses

Status CodeDescription
401Missing or invalid API key.
404Role not found.
429Rate limit exceeded.
500Internal server error.

On this page