Get light agent profile

GET {{baseUrl}}/api/v1/lightAgentProfile

This API fetches the different permissions configured for the light agent profile.

OAuth Scope

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

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"default":true,"permissions":{"crmInteg":{"crmContactsActivityEvents":false,"crmAccountsActivityEvents":false,"crmAccountsActivityTasks":false,"crmAccountsInfo":false,"crmContactsActivityCalls":false,"crmAccountsNotes":false,"crmAccountsActivityCalls":false,"crmContactsInfo":false,"crmContactsNotes":false,"crmContactsActivityTasks":false,"crmAccountsPotentials":false,"crmContactsPotentials":false},"reports":{"view":true,"edit":false,"create":false,"delete":false,"export":true},"tickets":{"mergeTickets":false,"changeOwner":false,"import":false,"handleUnassigned":false,"edit":false,"closeTicket":false,"mailReview":false,"delete":false,"view":true,"create":false,"addFollowers":false,"export":true,"mailSend":false,"unassignedChangeOwner":false,"shareTickets":false},"comments":{"edit":false,"delete":false},"social":{"view":true},"contracts":{"view":true,"import":false,"edit":false,"create":false,"delete":false,"export":true},"community":{"view":false},"products":{"view":true,"import":false,"edit":false,"create":false,"delete":false,"export":true},"agents":{"overview":true,"edit":false,"create":false,"delete":false,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":false,"import":false,"edit":false,"create":false,"delete":false,"export":true},"setup":{"timeTracking":false,"fetchAcrossDepartment":true,"globalReports":false,"exportPortalUsers":false,"layouts":false,"automation":false,"featureConfig":false,"customerHappiness":false,"department":false,"portal":false,"webForm":false,"rebranding":false,"email":false,"tabsAndFields":false,"exportUsers":false,"teams":true,"social":false,"templates":false,"moveRecords":false,"permission":false,"signUpApproval":false,"community":false,"importHistory":false,"manageAgents":false,"portalUsers":false,"managerDashboard":true,"googleAnalytics":true,"chat":false,"telephony":false},"financeInteg":{"sendInvoice":false,"createEstimate":false,"createContact":false,"viewInvoice":false,"createInvoice":false,"sendEstimate":false,"viewEstimate":false},"accounts":{"view":true,"import":false,"edit":false,"create":false,"delete":false,"export":true},"timeEntry":{"view":true,"edit":false,"create":false,"delete":false},"contacts":{"view":true,"import":false,"edit":false,"create":false,"delete":false,"export":true},"tasks":{"view":true,"import":false,"edit":false,"create":false,"delete":false,"export":true}},"name":"Light Agent","description":"Set the privilege for light agents","id":"15000000012421","isVisible":true,"type":"Light"}