Skip to main content

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

​
id
string
required

The unique identifier for this user.

Example:

"11446498"

​
type
enum<string>
required

The value will always be user.

Available options:
user
Example:

"user"

​
name
string

The display name of this user.

Maximum string length: 50
Example:

"Aaron Levie"

​
login
string<email>

The primary email address of this user.

Example:

"[email protected]"

​
created_at
string<date-time>

When the user object was created.

Example:

"2012-12-12T10:53:43-08:00"

​
modified_at
string<date-time>

When the user object was last modified.

Example:

"2012-12-12T10:53:43-08:00"

​
language
string

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

Example:

"en"

​
timezone
string<timezone>

The user's timezone.

Example:

"Africa/Bujumbura"

​
space_amount
integer<int64>

The user’s total available space amount in bytes.

Example:

11345156112

​
space_used
integer<int64>

The amount of space in use by the user.

Example:

1237009912

​
max_upload_size
integer<int64>

The maximum individual file size in bytes the user can have.

Example:

2147483648

​
status
enum<string>

The user's account status.

Available options:
active,
inactive,
cannot_delete_edit,
cannot_delete_edit_upload
Example:

"active"

​
job_title
string

The user’s job title.

Maximum string length: 100
Example:

"CEO"

​
phone
string

The user’s phone number.

Maximum string length: 100
Example:

"6509241374"

​
address
string

The user’s address.

Maximum string length: 255
Example:

"900 Jefferson Ave, Redwood City, CA 94063"

​
avatar_url
string

URL of the user’s avatar image.

Example:

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

​
notification_email
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.