CompanyUsers

Gets a simplified list of users in the currently active company (i.e. CompanyUsers), exposing only a few key properties. This method is exposed as POST, allowing you to submit a set of filters and parameters in the request body.

post/api/companyusers/simple/options

Request body

IncludeInactiveboolean
IncludeHiddenboolean
SortBySurnameboolean
SortByExternalReferenceboolean
SortByIdentityNumberboolean
LimitToDepartmentIdinteger nullable
LimitToTemplateIdinteger nullable
LimitToSalaryCycleIdinteger nullable
LimitToPayrollBatchNumberinteger nullable
LimitToUpdatedSincestring date-time nullable
IncludeUserTypesinteger nullable
IncludeDeletedboolean

Response

OK

Idinteger
IsActiveboolean
FirstNamestring
MiddleNamestring
LastNamestring
FullNamestring
RoleIdinteger
UserIdinteger
RecycleBinstring
IdentityNumberstring
ExternalReferencesstring[]
UserEmploymentIdsinteger[]
PersonalEmailstring
CompanyEmailstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.