Listing

GET

/api/v1/roles

Returns the roles defined in your workspace. A role is a bundle of permissions.

Call this first when creating or updating users: the id values here are what roleIds expects. Roles change rarely, so fetching once per run is enough.

Note this is unrelated to a user's role within a queue (agent or manager), which is set by Automation Queue → Add Member.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200

application/json

Bodyapplication/json

🟠401Unauthorized

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://apigw.klinkcx.com/api/v1/roles' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "requestId": "string",
    "data": [
        {
            "id": "string",
            "systemName": "string",
            "displayName": "string",
            "description": "string"
        }
    ]
}

Modified at 2026-08-10 03:17:50

Remove Member