Returns users with their details.

GET

https://api.awork.com/api/v1/users

GET

/api/v1/users

curl https://api.awork.com/api/v1/users \
     -H "Authorization: Bearer <token>"

200Retrieved

[
  {
    "firstName": "Carla",
    "lastName": "Creative",
    "birthDate": "1998-04-19T00:00:000Z",
    "gender": "female",
    "title": "Miss",
    "position": "string",
    "language": "en-GB",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": {
      "invitationAccepted": true,
      "isDeactivated": true
    },
    "createdOn": "2024-01-15T09:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedOn": "2024-01-15T09:30:00Z",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "isArchived": false,
    "isDeactivated": false,
    "deactivatedOn": "2024-01-15T09:30:00Z",
    "deletedOn": "2024-01-15T09:30:00Z",
    "hasImage": true,
    "shouldMigrateToConnect": true,
    "userContactInfos": [
      {
        "label": null,
        "value": null,
        "type": "address",
        "subType": "work",
        "addressLine1": "Torstrasse 140",
        "addressLine2": "Hof A",
        "zipCode": "10119",
        "city": "Berlin",
        "state": null,
        "country": "DE",
        "isAddress": true,
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdOn": "2024-01-15T09:30:00Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
        "updatedOn": "2024-01-15T09:30:00Z",
        "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "resourceVersion": 637825154598057900,
    "tags": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "color": "purple"
      }
    ],
    "teams": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Designers",
        "icon": "paintbrush",
        "color": "purple"
      }
    ],
    "isExternal": true
  }
]

Returns users with their details. Archived users are excluded by default; set ‘showArchived’ to include them. API users are included in the response.

Required Permissions

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.

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>

Authentication

AuthorizationBearer

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

Query parameters

showArchivedbooleanOptionalDefaults to false

Whether to show archived users.

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

firstNamestring or nullOptional0-1000 characters

The firstname of the user.

lastNamestring or nullOptional0-1000 characters

The lastname of the user.

birthDatestring or nullOptionalformat: "date-time"

The birthdate of the user.

genderstring or nullOptional0-25 characters

The gender of the user.

titlestring or nullOptional0-100 characters

The title of the user.

positionstring or nullOptional0-1000 characters

The position of the user.

languagestring or nullOptional0-25 characters

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

idstringOptionalformat: "uuid"

The id of the user.

statusobjectOptional

The status of the user.

createdOnstringOptionalformat: "date-time"

The date this user was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this user.

updatedOnstringOptionalformat: "date-time"

The date when this user was last updated.

updatedBystringOptionalformat: "uuid"

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.

deactivatedOnstring or nullOptionalformat: "date-time"

The date the user was deactivated.

deletedOnstring or nullOptionalformat: "date-time"

The date the user was deleted (soft delete).

hasImagebooleanOptional

Whether the user has uploaded a profile image.

shouldMigrateToConnectbooleanOptional

Whether the user should be migrated to Connect.

userContactInfoslist of objects or nullOptional

The contact information assigned to this user.

resourceVersionlongOptionalRead-only

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

tagslist of objects or nullOptional

The tags of this user.

teamslist of objects or nullOptional

The teams the user is associated to.

isExternalbooleanOptional

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