Skip to main content

List Roles

POST 
/role/list

Lists every role in a company, including roles nobody holds. Set includeHolders: true to also get each role's holderCount (active users who hold it directly or on any team; it can lag an assignment change by a few seconds) and autoEnrollPrograms (active programs that enroll a user when they are assigned the role). Omit companyId for your own company. Archived roles are excluded unless showArchived is set. Requires the role:list permission. Use this to check whether a role exists by name; use /role/get with includeHolders: true to see who holds a role.

Request​

Responses​

Success