Get role

GET {{baseUrl}}/api/v1/roles/:role_id

This API fetches the details of a particular role.

OAuth Scope

  • Desk.settings.READ
  • Desk.basic.READ

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"isDefault":true,"shareDataWithPeers":false,"immediateSubRoles":["4000000012420","4000000012417"],"name":"CEO","description":"Agent belongs to this role can access all other user's data.","reportsTo":null,"id":"4000000012414","isVisible":true}