v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Job Roles

Listing roles

Returns a list of job roles.

get/roles

Query parameters

idnumber

Role id to search for

namestring

Role name to search for

codestring

Role code to search for

fieldsstring

Specify fields to return (eg. fields=id,name or fields=all).
Default: id, name, createdAt, updatedAt

perPageinteger

Pagination: How many items per page

pageinteger

Pagination: Which page to query

Response

An array of roles

totalResultsinteger
pageinteger
totalPagesinteger