Box Developer Documentation
Log in

User

A standard representation of a user, as returned from any user API endpoints by default

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 user

string
"user"

user

Value is always user

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

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
"CEO"100

The user’s job title

string
"en"

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

string / email
"ceo@example.com"

The primary email address of this user

integer / int64
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

string
"Aaron Levie"50

The display name of this user

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
"6509241374"100

The user’s phone number

integer / int64
11345156112

The user’s total available space amount in bytes

integer / int64
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

Response Example

{
  "id": "11446498",
  "type": "user",
  "address": "900 Jefferson Ave, Redwood City, CA 94063",
  "avatar_url": "https://www.box.com/api/avatar/large/181216415",
  "created_at": "2012-12-12T10:53:43-08:00",
  "job_title": "CEO",
  "language": "en",
  "login": "ceo@example.com",
  "max_upload_size": 2147483648,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "name": "Aaron Levie",
  "notification_email": {
    "email": "notifications@example.com",
    "is_confirmed": true
  },
  "phone": "6509241374",
  "space_amount": 11345156112,
  "space_used": 1237009912,
  "status": "active",
  "timezone": "Africa/Bujumbura"
}