List all roles

List all roles for the organization, including built-in and custom roles.

GET /v1/roles

List all roles

cURL

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

200

{
  "builtInRoles": [
    {
      "name": "<string>",
      "isBuiltIn": true,
      "description": "<string>"
    }
  ],
  "customRoles": [
    {
      "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

Response

200

application/json

List of roles

builtInRoles · object[]

Show child attributes

customRoles · object[]

Show child attributes