klink-developers-logo

Role

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

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

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

Responses

200

OK

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataarray[object]required
    Child attributes
    • idstringrequired

      Role ID. Use this in roleIds when creating or updating a user.

    • systemNamestringrequired
    • displayNamestringrequired
    • descriptionstring | nullrequired
401

Unauthorized

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired