Qodex.ai

List profiles

GET {{baseUrl}}/api/v1/profiles

This API lists a particular number of user profiles, based on the limit specified.

OAuth Scope

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

Request Params

KeyDatatypeRequiredDescription
visiblestringKey that filters profiles according to their visibility in the UI
defaultstringKey that denotes whether the profiles must be default profiles or custom profiles
searchStrstringString to search for profile by name or description. The string must contain at least one character. Three search methods are supported: 1) string* - Searches for profiles whose name or description start with the string, 2) string - Searches for profiles whose name or description contain the string, 3) string - Searches for profiles whose name or description is an exact match for the string

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"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":true,"create":true,"delete":true,"export":true},"tickets":{"mergeTickets":true,"changeOwner":true,"import":true,"handleUnassigned":true,"edit":true,"closeTicket":true,"mailReview":true,"delete":true,"view":true,"create":true,"addFollowers":true,"export":true,"mailSend":true,"unassignedChangeOwner":false,"shareTickets":true},"comments":{"edit":true,"delete":true},"social":{"view":true},"contracts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"community":{"view":true,"edit":true,"create":true,"delete":true,"moderate":true},"products":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"agents":{"overview":true,"edit":false,"create":true,"delete":true,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"setup":{"timeTracking":true,"fetchAcrossDepartment":true,"globalReports":true,"exportPortalUsers":true,"layouts":true,"automation":true,"featureConfig":true,"customerHappiness":true,"department":true,"portal":true,"webForm":true,"rebranding":true,"email":true,"tabsAndFields":true,"exportUsers":true,"teams":true,"social":true,"templates":true,"moveRecords":true,"permission":true,"signUpApproval":true,"community":true,"importHistory":true,"manageAgents":true,"portalUsers":true,"managerDashboard":true,"googleAnalytics":true,"chat":true,"telephony":true},"financeInteg":{"sendInvoice":false,"createEstimate":false,"createContact":false,"viewInvoice":false,"createInvoice":false,"sendEstimate":false,"viewEstimate":false},"accounts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"timeEntry":{"view":true,"edit":true,"create":true,"delete":true},"contacts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"tasks":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true}},"name":"Support Administrator","description":"Set the privileges for support administrators.","id":"5000000015288","isVisible":true,"type":"Administrator"},{"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":true,"delete":true,"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":false,"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":"5000000015306","isVisible":true,"type":"Light"},{"default":false,"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":true,"create":true,"delete":true,"export":false},"tickets":{"mergeTickets":false,"changeOwner":true,"import":false,"handleUnassigned":true,"edit":true,"closeTicket":false,"mailReview":false,"delete":true,"view":true,"create":true,"addFollowers":false,"export":false,"mailSend":false,"unassignedChangeOwner":false,"shareTickets":false},"comments":{"edit":false,"delete":false},"social":{"view":true},"contracts":{"view":true,"import":false,"edit":true,"create":true,"delete":true,"export":false},"community":{"view":true},"products":{"view":true,"import":false,"edit":true,"create":true,"delete":true,"export":false},"agents":{"overview":true,"edit":false,"create":true,"delete":true,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":true,"import":false,"edit":true,"create":true,"delete":true,"export":false},"setup":{"timeTracking":false,"fetchAcrossDepartment":false,"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":false,"social":false,"templates":false,"moveRecords":false,"permission":false,"signUpApproval":false,"community":false,"importHistory":false,"manageAgents":false,"portalUsers":false,"managerDashboard":false,"googleAnalytics":false,"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":true,"create":true,"delete":true,"export":false},"timeEntry":{"view":true,"edit":true,"create":true,"delete":true},"contacts":{"view":true,"import":false,"edit":true,"create":true,"delete":true,"export":false},"tasks":{"view":true,"import":false,"edit":true,"create":true,"delete":true,"export":false}},"name":"Newbie Agent","description":"Set the privileges for new agents.","id":"5000000015303","isVisible":true,"type":"Custom"},{"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":false,"edit":false,"create":false,"delete":false,"export":false},"tickets":{"mergeTickets":false,"changeOwner":false,"import":false,"handleUnassigned":false,"edit":false,"closeTicket":false,"mailReview":false,"delete":false,"view":true,"create":true,"addFollowers":false,"export":true,"mailSend":false,"unassignedChangeOwner":false,"shareTickets":false},"comments":{"edit":false,"delete":false},"social":{"view":false},"contracts":{"view":false,"import":false,"edit":false,"create":false,"delete":false,"export":false},"community":{"view":false},"products":{"view":false,"import":false,"edit":false,"create":false,"delete":false,"export":false},"agents":{"overview":true,"edit":false,"create":true,"delete":true,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":false,"import":false,"edit":false,"create":false,"delete":false,"export":true},"setup":{"timeTracking":false,"fetchAcrossDepartment":false,"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":false,"social":false,"templates":false,"moveRecords":false,"permission":false,"signUpApproval":false,"community":false,"importHistory":false,"manageAgents":false,"portalUsers":false,"managerDashboard":false,"googleAnalytics":false,"chat":false,"telephony":false},"financeInteg":{"sendInvoice":false,"createEstimate":false,"createContact":false,"viewInvoice":false,"createInvoice":false,"sendEstimate":false,"viewEstimate":false},"accounts":{"view":false,"import":false,"edit":false,"create":false,"delete":false,"export":false},"timeEntry":{"view":false,"edit":false,"create":false,"delete":false},"contacts":{"view":false,"import":false,"edit":false,"create":false,"delete":false,"export":false},"tasks":{"view":false,"import":false,"edit":false,"create":false,"delete":false,"export":false}},"name":"Help Center","description":"This profile will have the permissions of End Users","id":"5000000015294","isVisible":false,"type":"Portal"},{"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":true,"create":true,"delete":true,"export":true},"tickets":{"mergeTickets":true,"changeOwner":true,"import":true,"handleUnassigned":true,"edit":true,"closeTicket":true,"mailReview":true,"delete":true,"view":true,"create":true,"addFollowers":true,"export":true,"mailSend":true,"unassignedChangeOwner":false,"shareTickets":false},"comments":{"edit":true,"delete":true},"social":{"view":true},"contracts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"community":{"view":true,"edit":true,"create":true,"delete":true,"moderate":false},"products":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"agents":{"overview":true,"edit":false,"create":true,"delete":true,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"setup":{"timeTracking":false,"fetchAcrossDepartment":true,"globalReports":false,"exportPortalUsers":true,"layouts":false,"automation":false,"featureConfig":false,"customerHappiness":false,"department":false,"portal":false,"webForm":false,"rebranding":false,"email":false,"tabsAndFields":false,"exportUsers":true,"teams":false,"social":false,"templates":false,"moveRecords":true,"permission":false,"signUpApproval":false,"community":false,"importHistory":true,"manageAgents":false,"portalUsers":false,"managerDashboard":false,"googleAnalytics":false,"chat":false,"telephony":false},"financeInteg":{"sendInvoice":false,"createEstimate":false,"createContact":false,"viewInvoice":false,"createInvoice":false,"sendEstimate":false,"viewEstimate":false},"accounts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"timeEntry":{"view":true,"edit":true,"create":true,"delete":true},"contacts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"tasks":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true}},"name":"Agent","description":"Set the privileges for standard agents","id":"5000000015291","isVisible":true,"type":"Standard"},{"default":false,"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":true,"create":true,"delete":true,"export":true},"tickets":{"mergeTickets":true,"changeOwner":true,"import":true,"handleUnassigned":true,"edit":true,"closeTicket":true,"mailReview":true,"delete":true,"view":true,"create":true,"addFollowers":true,"export":true,"mailSend":true,"unassignedChangeOwner":false,"shareTickets":false},"comments":{"edit":true,"delete":true},"social":{"view":true},"contracts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"community":{"view":true,"edit":true,"create":true,"delete":true,"moderate":true},"products":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"agents":{"overview":true,"edit":false,"create":true,"delete":true,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"setup":{"timeTracking":false,"fetchAcrossDepartment":true,"globalReports":false,"exportPortalUsers":true,"layouts":false,"automation":false,"featureConfig":false,"customerHappiness":false,"department":false,"portal":false,"webForm":false,"rebranding":false,"email":false,"tabsAndFields":false,"exportUsers":true,"teams":false,"social":false,"templates":false,"moveRecords":true,"permission":false,"signUpApproval":false,"community":false,"importHistory":true,"manageAgents":false,"portalUsers":false,"managerDashboard":true,"googleAnalytics":false,"chat":false,"telephony":false},"financeInteg":{"sendInvoice":false,"createEstimate":false,"createContact":false,"viewInvoice":false,"createInvoice":false,"sendEstimate":false,"viewEstimate":false},"accounts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"timeEntry":{"view":true,"edit":true,"create":true,"delete":true},"contacts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"tasks":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true}},"name":"Supervisor","description":"Set the privileges for supervisory users.","id":"5000000015297","isVisible":true,"type":"Custom"},{"default":false,"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":true,"create":true,"delete":true,"export":true},"tickets":{"mergeTickets":true,"changeOwner":true,"import":true,"handleUnassigned":true,"edit":true,"closeTicket":true,"mailReview":true,"delete":true,"view":true,"create":true,"addFollowers":true,"export":true,"mailSend":true,"unassignedChangeOwner":false,"shareTickets":false},"comments":{"edit":true,"delete":true},"social":{"view":true},"contracts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"community":{"view":true,"edit":true,"create":true,"delete":true,"moderate":true},"products":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"agents":{"overview":true,"edit":false,"create":true,"delete":true,"viewAllFields":true},"kbCategory":{"view":true,"editAllArticles":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"setup":{"timeTracking":false,"fetchAcrossDepartment":true,"globalReports":false,"exportPortalUsers":true,"layouts":false,"automation":true,"featureConfig":false,"customerHappiness":false,"department":false,"portal":false,"webForm":false,"rebranding":false,"email":false,"tabsAndFields":false,"exportUsers":true,"teams":false,"social":false,"templates":false,"moveRecords":true,"permission":false,"signUpApproval":false,"community":false,"importHistory":true,"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":true,"edit":true,"create":true,"delete":true,"export":true},"timeEntry":{"view":true,"edit":true,"create":true,"delete":true},"contacts":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true},"tasks":{"view":true,"import":true,"edit":true,"create":true,"delete":true,"export":true}},"name":"Support Manager","description":"Set the privileges for managerial users.","id":"5000000015300","isVisible":true,"type":"Custom"}]}