v1
latestOpenAPI 3.0.02026-07-24161168406.5 KBRole
List roles with pagination
Returns a paginated list of roles for the company. Use expand=company,positions to load relations. When externalCode is set, the list is filtered to matching roles (case-insensitive). If none match, data is empty and total is 0.
get/os/v1/roles
Query parameters
externalCodestring
Example:RL-F98
Optional. Filter by role external code (case-insensitive exact match).
pagenumber
Example:1
Page number for pagination
maxPageSizenumber
Example:20
Maximum page size for pagination
expandstring
Example:company,positions
Optional relations, comma-separated: company, positions
Response
Roles retrieved successfully