User (Full)

A full representation of a user, as can be returned from any user API endpoint.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.


The unique identifier for this user



Value is always user

"900 Jefferson Ave, Redwood City, CA 94063"255

The user’s address


URL of the user’s avatar image


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

string / date-time

When the user object was created


Representation of the user’s enterprise


The unique identifier for this enterprise.



Value is always enterprise

"Acme Inc."

The name of the enterprise


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.


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


Whether to exempt the user from Enterprise device limits


Whether the user must use two-factor authentication


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


Whether the user is an App User


Whether the user can use Box Sync


The user’s job title


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

string / email

The primary email address of this user

integer / int64

The maximum individual file size in bytes the user can have

string / date-time

When the user object was last modified

string array

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

"Aaron Levie"50

The display name of this user

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.


The email address to send the notifications to.


Specifies if this email address has been confirmed.


The user’s phone number


The user’s enterprise role

Value is one of admin,coadmin,user

integer / int64

The user’s total available space amount in bytes

integer / int64

The amount of space in use by the user


The user's account status

Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload

string / timezone

The user's timezone

object array

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.



Value is always tracking_code


The name of the tracking code, which must be preconfigured in the Admin Console


The value of the tracking code

Response Example

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