Skip to main content
API version 2024.0 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.
​
id
string
example: 11446498The unique identifier for this user.
​
type
string
example: userThe value will always be user.Value is always user
​
address
string
example: 900 Jefferson Ave, Redwood City, CA 94063The user’s address.
​
avatar_url
string
example: https://www.box.com/api/avatar/large/181216415URL of the user’s avatar image.
​
can_see_managed_users
boolean
example: trueWhether the user can see other enterprise users in their contact list.
​
created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the user object was created.
​
enterprise
object
Representation of the user’s enterprise.
​
external_app_user_id
string
example: my-user-1234An 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.
​
hostname
string
example: https://example.app.box.com/The root (protocol, subdomain, domain) of any links that need to be generated for the user.
​
is_exempt_from_device_limits
boolean
example: trueWhether to exempt the user from Enterprise device limits.
​
is_exempt_from_login_verification
boolean
example: trueWhether the user must use two-factor authentication.
​
is_external_collab_restricted
boolean
example: trueWhether the user is allowed to collaborate with users outside their enterprise.
​
is_platform_access_only
boolean
example: trueWhether the user is an App User.
​
is_sync_enabled
boolean
example: trueWhether the user can use Box Sync.
​
job_title
string
example: CEOThe user’s job title.
​
language
string
example: enThe language of the user, formatted in modified version of the ISO 639-1 format.
​
login
string(email)
example: [email protected]The primary email address of this user.
​
max_upload_size
integer(int64)
example: 2147483648The maximum individual file size in bytes the user can have.
​
modified_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the user object was last modified.
​
my_tags
stringarray
example: ["important"]Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.
​
name
string
example: Aaron LevieThe 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.
​
phone
string
example: 6509241374The user’s phone number.
​
role
string
example: adminThe user’s enterprise role.Value is one of admin,coadmin,user
​
space_amount
integer(int64)
example: 11345156112The user’s total available space amount in bytes.
​
space_used
integer(int64)
example: 1237009912The amount of space in use by the user.
​
status
string
example: activeThe user’s account status.Value is one of active,inactive,cannot_delete_edit,cannot_delete_edit_upload
​
timezone
string(timezone)
example: Africa/BujumburaThe user’s timezone.
​
tracking_codes
object[]
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.
{
  "id": "11446498",
  "type": "user",
  "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",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "external_app_user_id": "my-user-1234",
  "hostname": "https://example.app.box.com/",
  "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": "[email protected]",
  "max_upload_size": 2147483648,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "my_tags": [
    "important"
  ],
  "name": "Aaron Levie",
  "notification_email": {
    "email": "[email protected]",
    "is_confirmed": true
  },
  "phone": "6509241374",
  "role": "admin",
  "space_amount": 11345156112,
  "space_used": 1237009912,
  "status": "active",
  "timezone": "Africa/Bujumbura",
  "tracking_codes": [
    {
      "name": "department",
      "type": "tracking_code",
      "value": "Sales"
    }
  ]
}