---
title: "GET /api/v1/users"
method: GET
path: "/api/v1/users"
---

# GET /api/v1/users

`GET /api/v1/users`

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

## Query parameters

- `organizationId` string
- `userIds` string
- `query` string, password
- `include` 'ALL' | 'ACTIVE_PENDING'
- `order` 'ASCENDING' | 'DESCENDING'
- `sort` 'USER_NAME' | 'FULL_NAME' | 'STORAGE_LIMIT' | 'USER_STATUS' | 'STORAGE_USED'
- `marker` string
- `limit` integer
- `fields` string
- `Limit` string
- `Marker` string

## Headers

- `Authentication` string, password

## Response `200`

Success

- DescribeUsersResponse
  - `Users` User[] — The users.
    - `Id` string — The ID of the user.
    - `Username` string, password — The login name of the user.
    - `EmailAddress` string, password — The email address of the user.
    - `GivenName` string, password — The given name of the user.
    - `Surname` string, password — The surname of the user.
    - `OrganizationId` string — The ID of the organization.
    - `RootFolderId` string — The ID of the root folder.
    - `RecycleBinFolderId` string — The ID of the recycle bin folder.
    - `Status` 'ACTIVE' | 'INACTIVE' | 'PENDING' — The status of the user.
    - `Type` 'USER' | 'ADMIN' | 'POWERUSER' | 'MINIMALUSER' | 'WORKSPACESUSER' — The type of user.
    - `CreatedTimestamp` string, date-time — The time when the user was created.
    - `ModifiedTimestamp` string, date-time — The time when the user was modified.
    - `TimeZoneId` string — The time zone ID of the user.
    - `Locale` 'en' | 'fr' | 'ko' | 'de' | 'es' | 'ja' | 'ru' | 'zh_CN' | 'zh_TW' | 'pt_BR' | 'default' — The locale of the user.
    - `Storage` object — The storage for the user.
      - `StorageUtilizedInBytes` integer — The amount of storage used, in bytes.
      - `StorageRule` object — The storage for a user.
        - `StorageAllocatedInBytes` integer — The amount of storage allocated, in bytes.
        - `StorageType` 'UNLIMITED' | 'QUOTA' — The type of storage.
  - `TotalNumberOfUsers` integer — The total number of users included in the results.
  - `Marker` string — The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

## Other responses

- `480` — EntityNotExistsException
- `481` — UnauthorizedOperationException
- `482` — UnauthorizedResourceAccessException
- `483` — FailedDependencyException
- `484` — ServiceUnavailableException
- `485` — InvalidArgumentException
- `486` — RequestedEntityTooLargeException

---

[API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)