users

Returns users with their details.

Changed on

Returns users with their details. Archived users are excluded by default; set 'showArchived' to include them. API users are included in the response. <Check title="Required Permissions" icon="key">The user must have user-master-data:read permission to see all workspace users. Without it, the response contains only the requesting user. If team restrictions apply, the response is limited to users in the user's teams.</Check>

get/users

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/users
  • Auth: HTTP bearer

Query parameters

showArchivedboolean

Whether to show archived users.

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

firstNamestring nullable

The firstname of the user.

lastNamestring nullable

The lastname of the user.

birthDatestring date-time nullable

The birthdate of the user.

genderstring nullable

The gender of the user.

titlestring nullable

The title of the user.

positionstring nullable

The position of the user.

languagestring nullable

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

idstring uuid

The id of the user.

createdOnstring date-time

The date this user was created.

createdBystring uuid

The id of the user who created this user.

updatedOnstring date-time

The date when this user was last updated.

updatedBystring uuid

The id of the user who updated the entity.

isArchivedboolean

Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.

isDeactivatedboolean

Whether the user has been deactivated.

deactivatedOnstring date-time nullable

The date the user was deactivated.

deletedOnstring date-time nullable

The date the user was deleted (soft delete).

hasImageboolean

Whether the user has uploaded a profile image.

shouldMigrateToConnectboolean

Whether the user should be migrated to Connect.

resourceVersioninteger

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

isExternalboolean

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • d116d3e9e7d6Revision changes
    • warning

      removed the optional property / from the response with the status