Get All Roles

To list all Roles in your app.

The response body will be a JSON object with a key of result. This will be set to an array containing objects each representing a role. These will contain the standard role attributes.

Responses

🟢200OK

application/json

Body

Example

{
    "success": true,
    "message": "OK.",
    "meta": {},
    "errors": [],
    "result": [
        {
            "id": "0afadfbfbd300ef5847e4eb4",
            "name": "Admin",
            "icon": "ri-shield-user-line",
            "color": "#ffffff",
            "permissions": [
                "read:letter"
            ],
            "userCount": "3",
            "createdAt": "2025-11-26T09:42:43.294Z",
            "updatedAt": "2025-11-26T09:42:43.294Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Get All Roles

Request

Request Code Samples

Responses