List roles by role IDs

GET {{baseUrl}}/api/v1/rolesByIds?roleIds=<long>

This API lists details of the roles whose IDs are passed in the API request.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
roleIdsstringComma separated role ids. Maximum allowed count is 50

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;isDefault&quot;:true,&quot;shareDataWithPeers&quot;:false,&quot;immediateSubRoles&quot;:[&quot;4000000012420&quot;,&quot;4000000012417&quot;],&quot;name&quot;:&quot;CEO&quot;,&quot;description&quot;:&quot;Agent belongs to this role can access all other user&#39;s data.&quot;,&quot;reportsTo&quot;:null,&quot;id&quot;:&quot;4000000012414&quot;,&quot;isVisible&quot;:true},{&quot;isDefault&quot;:false,&quot;shareDataWithPeers&quot;:false,&quot;immediateSubRoles&quot;:[],&quot;name&quot;:&quot;PortalUser&quot;,&quot;description&quot;:&quot;User belongs to this role are portal users they can access their cases and solutions only&quot;,&quot;reportsTo&quot;:&quot;4000000012414&quot;,&quot;id&quot;:&quot;4000000012420&quot;,&quot;isVisible&quot;:false},{&quot;isDefault&quot;:false,&quot;shareDataWithPeers&quot;:false,&quot;immediateSubRoles&quot;:[],&quot;name&quot;:&quot;Personal&quot;,&quot;description&quot;:&quot;Agents belongs to this role can see only unassigned and his/her data&quot;,&quot;reportsTo&quot;:null,&quot;id&quot;:&quot;4000000012423&quot;,&quot;isVisible&quot;:false}]}