Join BoxWorks 2024 to discover what's possible with content and AI!

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.

id string

example11446498

The unique identifier for this user

type string

exampleuser

user

Value is always user

address string

example900 Jefferson Ave, Redwood City, CA 94063max length255

The user’s address

avatar_url string

examplehttps://www.box.com/api/avatar/large/181216415

URL of the user’s avatar image

created_at string (date-time)

example2012-12-12T10:53:43-08:00

When the user object was created

job_title string

exampleCEOmax length100

The user’s job title

language string

exampleen

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

max_upload_size integer (int64)

example2147483648

The maximum individual file size in bytes the user can have

modified_at string (date-time)

example2012-12-12T10:53:43-08:00

When the user object was last modified

name string

exampleAaron Leviemax length50

The display name of this user

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.

notification_email.email string

examplenotifications@example.com

The email address to send the notifications to.

notification_email.is_confirmed boolean

exampletrue

Specifies if this email address has been confirmed.

phone string

example6509241374max length100

The user’s phone number

space_amount integer (int64)

example11345156112

The user’s total available space amount in bytes

space_used integer (int64)

example1237009912

The amount of space in use by the user

status string

exampleactive

The user's account status

Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload

timezone string (timezone)

exampleAfrica/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"
}