Welcome to the New BigPanda API Documentation

Retrieve a Role

US Region

https://api.biggy.io

GET

/roles/{roleId}

Retrieve a single role and associated permissions by Role ID.

🚧 Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.

📘 Required permissions
Your account must have the Role Management permission set to View to use this endpoint.

❗ Rate limitations
To maintain quality of service, the Biggy API is limited to 100 requests per minute. Additional requests will return a 429 response code and the request will need to be retried.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200

application/json

Bodyapplication/json

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.biggy.io/roles/65f0c8f8d73b2b0012ab1123' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "role": {
        "id": "65f0c8f8d73b2b0012ab1111",
        "name": "System Admin",
        "type": "system",
        "permissions": [
            {
                "resourceType": "user_mgmt",
                "resourceName": "*",
                "actions": [
                    "view",
                    "edit"
                ]
            }
        ],
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
    }
}

Modified at 2026-09-04 16:33:43

Roles

Retrieve All Roles