Box Developer Documentation
Log in

User

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

Base
Mini
Standard

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

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
11446498

The unique identifier for this object

string
user

Value is always user

string / email
ceo@example.com

The primary email address of this user

string
Aaron Levie50

The display name of this user

string
900 Jefferson Ave, Redwood City, CA 94063255

The user’s address

string
https://www.box.com/api/avatar/large/181216415

URL of the user’s avatar image

string / date-time
2012-12-12T10:53:43-08:00

When the user object was created

string
CEO100

The user’s job title

string
en

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

integer
2147483648

The maximum individual file size in bytes the user can have

string / date-time
2012-12-12T10:53:43-08:00

When the user object was last modified

object

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.

string
notifications@example.com

The email address to send the notifications to.

boolean
true

Specifies if this email address has been confirmed.

string
6509241374100

The user’s phone number

integer
11345156112

The user’s total available space amount in bytes

integer
1237009912

The amount of space in use by the user

string
active

The user's account status

Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload

string / timezone
Africa/Bujumbura

The user's timezone

Full

Response Example

{
  "address": "900 Jefferson Ave, Redwood City, CA 94063",
  "avatar_url": "https://www.box.com/api/avatar/large/181216415",
  "can_see_managed_users": true,
  "created_at": "2012-12-12T10:53:43-08:00",
  "enterprise": {
    "id": 11446498,
    "name": "Acme Inc.",
    "type": "enterprise"
  },
  "external_app_user_id": "my-user-1234",
  "hostname": "https://example.app.box.com/",
  "id": 11446498,
  "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": "ceo@example.com",
  "max_upload_size": 2147483648,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "my_tags": [
    "important"
  ],
  "name": "Aaron Levie",
  "notification_email": {
    "email": "notifications@example.com",
    "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"
    }
  ],
  "type": "user"
}