---
title: "Returns all users with their details."
method: GET
path: "/users"
tags: ["users"]
---

# Returns all users with their details.

`GET /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.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

## Query parameters

- `showArchived` boolean
- `page` integer
- `pageSize` integer
- `orderby` string
- `filterby` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- User[]
  - `firstName` string, nullable — The firstname of the user.
  - `lastName` string, nullable — The lastname of the user.
  - `birthDate` string, date-time, nullable — The birthdate of the user.
  - `gender` string, nullable — The gender of the user.
  - `title` string, nullable — The title of the user.
  - `position` string, nullable — The position of the user.
  - `language` string, nullable — The language preference of the user in ISO 639-1 format.
  - `id` string, uuid — The id of the user.
  - `status` UserStatus — The status of the user.
    - `invitationAccepted` boolean — Flag if the user in this workspace accepted the invitation.
    - `isDeactivated` boolean — Whether the user is deactivated.
  - `createdOn` string, date-time — The date this user was created.
  - `createdBy` string, uuid — The id of the user who created this user.
  - `updatedOn` string, date-time — The date when this user was last updated.
  - `updatedBy` string, uuid — The id of the user who updated the entity.
  - `isArchived` boolean — Whether this user is archived. Archived users are automatically inactive and only exist for reference purposes.
  - `isDeactivated` boolean — Whether the user has been deactivated.
  - `isAgent` boolean — Whether this user represents an agent.
  - `deactivatedOn` string, date-time, nullable — The date the user was deactivated.
  - `deletedOn` string, date-time, nullable — The date the user was deleted (soft delete).
  - `hasImage` boolean — Whether the user has uploaded a profile image.
  - `shouldMigrateToConnect` boolean — Whether the user should be migrated to Connect.
  - `userContactInfos` ContactInfo[], nullable — The contact information assigned to this user.
    - `label` string, nullable — The label of the contact info. Only necessary if type 'custom' is used.
    - `value` string, nullable — The value of the contact info.
    - `type` string, nullable — The type of the contact info. Possible values are: phone, email, address, messenger, social, urls.
    - `subType` string, nullable — The subtype of the contact info, Possible values are: Phone: [ 'work', 'mobile', 'home', 'work Fax', 'fax', 'other' ] Email: [ 'work', 'private', 'other' ] address: [ 'work', 'home', 'other' ] Messenger: [ 'skype', 'whatsapp', 'other' ] social: [ 'facebook', 'twitter', 'xing', 'linkedIn', 'instagram', 'pinterest', 'other' ] urls: [ 'work', 'private', 'gitHub', 'other' ].
    - `addressLine1` string, nullable — The first Address line of the address.
    - `addressLine2` string, nullable — The second address line of the contact info.
    - `zipCode` string, nullable — The Zipcode of the contact info.
    - `city` string, nullable — The city of the contact info.
    - `state` string, nullable — The state of the contact info.
    - `country` string, nullable — The 2 letter iso code of the country.
    - `isAddress` boolean — Flags whether this contactinfo is an address or not. If its an address, the address fields are required.
    - `id` string, uuid — The Id of the contact info.
    - `createdOn` string, date-time — The creation date.
    - `createdBy` string, uuid, nullable — The id of the user who created the entity.
    - `updatedOn` string, date-time — The date when the entity was updated.
    - `updatedBy` string, uuid, nullable — the id of the user who updated the entity.
  - `resourceVersion` integer — The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
  - `tags` UserTagModel[], nullable — The tags of this user.
    - `id` string, uuid
    - `name` string, nullable — The name of the tag.
    - `color` string, nullable — The color of the tag.
  - `teams` TeamModel[], nullable — The teams the user is associated to.
    - `id` string, uuid — The id of the team.
    - `name` string, nullable — The name of the team.
    - `icon` string, nullable — The icon which is assigned to the team.
    - `color` string, nullable — The color of the team.
  - `isExternal` boolean — True if this entity is coming from an external workspace (awork Connect).

---

[API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)