v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Users

Get user

Retrieves information about a user in the enterprise.

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

This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

get/users/{user_id}

Path parameters

user_idstring required

The ID of the user.

Query parameters

fieldsstring[]

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Response

Returns a single user object.

Not all available fields are returned by default. Use the fields query parameter to explicitly request any specific fields using the fields parameter.

idstring required

The unique identifier for this user.

type'user' required

The value will always be user.

namestring

The display name of this user.

loginstring email

The primary email address of this user.

created_atstring date-time

When the user object was created.

modified_atstring date-time

When the user object was last modified.

languagestring

The language of the user, formatted in modified version of the ISO 639-1 format.

timezonestring timezone

The user's timezone.

space_amountinteger

The user’s total available space amount in bytes.

space_usedinteger

The amount of space in use by the user.

max_upload_sizeinteger

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_titlestring

The user’s job title.

phonestring

The user’s phone number.

addressstring

The user’s address.

avatar_urlstring

URL of the user’s avatar image.

role'admin' | 'coadmin' | 'user'

The user’s enterprise role.

can_see_managed_usersboolean

Whether the user can see other enterprise users in their contact list.

is_sync_enabledboolean

Whether the user can use Box Sync.

is_external_collab_restrictedboolean

Whether the user is allowed to collaborate with users outside their enterprise.

is_exempt_from_device_limitsboolean

Whether to exempt the user from Enterprise device limits.

is_exempt_from_login_verificationboolean

Whether the user must use two-factor authentication.

my_tagsstring[]

Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.

hostnamestring

The root (protocol, subdomain, domain) of any links that need to be generated for the user.

is_platform_access_onlyboolean

Whether the user is an App User.

external_app_user_idstring

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.

Example response

{
  "id": "11446498",
  "type": "user",
  "name": "Aaron Levie",
  "login": "ceo@example.com",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "language": "en",
  "timezone": "Africa/Bujumbura",
  "space_amount": 11345156112,
  "space_used": 1237009912,
  "max_upload_size": 2147483648,
  "status": "active",
  "job_title": "CEO",
  "phone": "6509241374",
  "address": "900 Jefferson Ave, Redwood City, CA 94063",
  "avatar_url": "https://www.box.com/api/avatar/large/181216415",
  "notification_email": {
    "email": "notifications@example.com",
    "is_confirmed": true
  },
  "role": "admin",
  "tracking_codes": [
    {
      "type": "tracking_code",
      "name": "department",
      "value": "Sales"
    }
  ],
  "can_see_managed_users": true,
  "is_sync_enabled": true,
  "is_external_collab_restricted": true,
  "is_exempt_from_device_limits": true,
  "is_exempt_from_login_verification": true,
  "enterprise": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "my_tags": [
    "important"
  ],
  "hostname": "https://example.app.box.com/",
  "is_platform_access_only": true,
  "external_app_user_id": "my-user-1234"
}