v1
latestOpenAPI 3.0.02026-07-24161168406.5 KBCompany Users
Listing users
Returns a list of company users.
get/users
Query parameters
idnumber
User id to search for
emailstring
User email to search for
departmentIdnumber
User departmentId to search for
roleIdnumber
User roleId to search for
profileTestEnabledboolean
Profile test enabling to search for
type'root' | 'owner' | 'guest'
User type to search for
profileTestStatusboolean
Test status to search for
testStatusboolean
External profile test status to search for
taxpayerRegistrystring
TaxpayerRegistry to search for
countryOfOriginstring
countryOfOrigin to search for
codenumber
User identifier 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 departments