API v1 ReferenceUsers

Returns all users.

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.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

showArchivedbooleanOptionalDefaults to false
Include archived users in the results. Not required. False by default.
pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
firstNamestring or null>=0 characters<=1000 characters
The firstname of the user.
lastNamestring or null>=0 characters<=1000 characters
The lastname of the user.
birthDatedatetime or null
The birthdate of the user.
genderstring or null>=0 characters<=25 characters
The gender of the user.
titlestring or null>=0 characters<=100 characters
The title of the user.
positionstring or null>=0 characters<=1000 characters
The position of the user.
languagestring or null>=0 characters<=25 characters

The language preference of the user in ISO 639-1 format.

idUUID or null
The id of the user.
statusobject or null
The status of the user.
createdOndatetime or null
The date this user was created.
createdByUUID or null
The id of the user who created this user.
updatedOndatetime or null
The date when this user was last updated.
updatedByUUID or null
The id of the user who updated the entity.
isArchivedboolean or null
Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.
isDeactivatedboolean or null
Whether the user has been deactivated.
deactivatedOndatetime or null
The date the user was deactivated.
hasImageboolean or null
Whether the user has uploaded a profile image.
shouldMigrateToConnectboolean or null
Whether the user should be migrated to Connect.
userContactInfoslist of objects or null
The contact information assigned to this user.
resourceVersionlong or null
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
tagslist of objects or null
The tags of this user.
teamslist of objects or null
The teams the user is associated to.
isExternalboolean or null

True if this entity is coming from an external workspace (awork Connect).