---
title: "List enterprise users"
method: GET
path: "/users"
tags: ["Users"]
---

# List enterprise users

`GET /users`

Returns a list of all users for the Enterprise along with their `user_id`,
`public_name`, and `login`.

The application and the authenticated user need to
have the permission to look up users in the entire
enterprise.

## Query parameters

- `filter_term` string
- `user_type` 'all' | 'managed' | 'external'
- `external_app_user_id` string
- `fields` string[]
- `offset` integer
- `limit` integer
- `usemarker` boolean
- `marker` string

## Response `200`

Returns all of the users in the enterprise.

- Users — The part of an API response that describes pagination.
  - `limit` integer — The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
  - `next_marker` string, nullable — The marker for the start of the next page of results.
  - `prev_marker` string, nullable — The marker for the start of the previous page of results.
  - `total_count` integer — One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than `total_count`. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
  - `offset` integer — The 0-based offset of the first entry in this set. This will be the same as the `offset` query parameter. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
  - `order` object[] — The order by which items are returned. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
    - `by` string — The field to order by.
    - `direction` 'ASC' | 'DESC' — The direction to order by, either ascending or descending.
  - `entries` UserFull[] — A list of users.
    - `id` string, required — The unique identifier for this user.
    - `type` 'user', required — The value will always be `user`.
    - `name` string — The display name of this user.
    - `login` string, email — The primary email address of this user.
    - `created_at` string, date-time — When the user object was created.
    - `modified_at` string, date-time — When the user object was last modified.
    - `language` string — The language of the user, formatted in modified version of the [ISO 639-1](https://developer.box.com/guides/api-calls/language-codes) format.
    - `timezone` string, timezone — The user's timezone.
    - `space_amount` integer — The user’s total available space amount in bytes.
    - `space_used` integer — The amount of space in use by the user.
    - `max_upload_size` integer — The maximum individual file size in bytes the user can have.
    - `status` 'active' | 'inactive' | 'cannot_delete_edit' | 'cannot_delete_edit_upload' — The user's account status.
    - `job_title` string — The user’s job title.
    - `phone` string — The user’s phone number.
    - `address` string — The user’s address.
    - `avatar_url` string — URL of the user’s avatar image.
    - `notification_email` object, nullable — An alternate notification email address to which email notifications are sent. When it's confirmed, this will be the email address to which notifications are sent instead of to the primary email address.
      - `email` string — The email address to send the notifications to.
      - `is_confirmed` boolean — Specifies if this email address has been confirmed.
    - `role` 'admin' | 'coadmin' | 'user' — The user’s enterprise role.
    - `tracking_codes` TrackingCode[] — Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for an enterprise before it can be used.
      - `type` 'tracking_code' — The value will always be `tracking_code`.
      - `name` string — The name of the tracking code, which must be preconfigured in the Admin Console.
      - `value` string — The value of the tracking code.
    - `can_see_managed_users` boolean — Whether the user can see other enterprise users in their contact list.
    - `is_sync_enabled` boolean — Whether the user can use Box Sync.
    - `is_external_collab_restricted` boolean — Whether the user is allowed to collaborate with users outside their enterprise.
    - `is_exempt_from_device_limits` boolean — Whether to exempt the user from Enterprise device limits.
    - `is_exempt_from_login_verification` boolean — Whether the user must use two-factor authentication.
    - `enterprise` object — Representation of the user’s enterprise.
      - `id` string — The unique identifier for this enterprise.
      - `type` 'enterprise' — The value will always be `enterprise`.
      - `name` string — The name of the enterprise.
    - `my_tags` string[] — Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.
    - `hostname` string — The root (protocol, subdomain, domain) of any links that need to be generated for the user.
    - `is_platform_access_only` boolean — Whether the user is an App User.
    - `external_app_user_id` string — An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.

## Other responses

- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)