Get All Roles

GET

/roles

Requires authenticated session. Requires manage:role permission.

Request

Authorization

API Key

Add parameter in cookie

core.session_token

Example:

core.session_token: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Body

🟠400bad-request

🟠401unauthorized

🟠403forbidden

🔴500server-error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/roles?limit&page&search&sortBy&sortOrder'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0
    },
    "errors": [
        {
            "code": "string",
            "field": "string",
            "message": "string"
        }
    ],
    "result": [
        {
            "id": "string",
            "name": "string",
            "icon": "string",
            "color": "string",
            "permissions": [
                "string"
            ],
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "userCount": 0
        }
    ]
}

Modified at 2026-05-01 04:13:11

Create a Presigned URL

Create a Role