Get a role by ID

Get details of a specific custom role.

GET /v1/roles/{roleId}

Get a role by ID

cURL

curl --request GET \
  --url http://localhost:3333/v1/roles/{roleId} \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "permissions": {},
  "isBuiltIn": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

roleId · string · required

Role ID

Example:

"rol_abc123"

Response

200

application/json

Role details

id · string

name · string

permissions · object

isBuiltIn · boolean

createdAt · string<date-time>

updatedAt · string<date-time>