Returns all users.

GET

Returns all users with their details like status, contact info and more. Returns all users if the user has read permissions on the feature user-master-data, otherwise returns only his own user. Archived users are excluded by default. You can include them by setting the ‘showArchived’ query parameter. If the permissions have UserTeamsData Feature, the filter for teams is applied. Beware that this will also include API users in the response.

Required Permissions: Any authenticated user.

Query parameters

showArchivedbooleanOptional
Include archived users in the results. Not required. False by default.
pageintegerOptional
Page number for pagination
pageSizeintegerOptional
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

This endpoint returns a list of objects
firstNamestringOptional
The firstname of the user.
lastNamestringOptional
The lastname of the user.
birthDatedatetimeOptional
The birthdate of the user.
genderstringOptional
The gender of the user.
titlestringOptional
The title of the user.
positionstringOptional
The position of the user.
languagestringOptional
The language preference of the user in ISO 639-1 format.
idstringOptional
The id of the user.
statusobjectOptional
The status of the user.
createdOndatetimeOptional
The date this user was created.
createdBystringOptional
The id of the user who created this user.
updatedOndatetimeOptional
The date when this user was last updated.
updatedBystringOptional
The id of the user who updated the entity.
isArchivedbooleanOptional
Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.
isDeactivatedbooleanOptional
Whether the user has been deactivated.
deactivatedOndatetimeOptional
The date the user was deactivated.
hasImagebooleanOptional
Whether the user has uploaded a profile image.
shouldMigrateToConnectbooleanOptional
Whether the user should be migrated to Connect.
userContactInfoslist of objectsOptional
The contact information assigned to this user.
resourceVersionlongOptional
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
tagslist of objectsOptional
The tags of this user.
teamslist of objectsOptional
The teams the user is associated to.
isExternalbooleanOptional
True if this entity is coming from an external workspace (awork Connect).