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

User (Full)

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

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

can_see_managed_users boolean

exampletrue

Whether the user can see other enterprise users in their contact list

created_at string (date-time)

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

When the user object was created

enterprise object

Representation of the user’s enterprise

enterprise.id string

example11446498

The unique identifier for this enterprise.

enterprise.type string

exampleenterprise

enterprise

Value is always enterprise

enterprise.name string

exampleAcme Inc.

The name of the enterprise

external_app_user_id string

examplemy-user-1234

An 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

examplehttps://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

exampletrue

Whether to exempt the user from Enterprise device limits

is_exempt_from_login_verification boolean

exampletrue

Whether the user must use two-factor authentication

is_external_collab_restricted boolean

exampletrue

Whether the user is allowed to collaborate with users outside their enterprise

is_platform_access_only boolean

exampletrue

Whether the user is an App User

is_sync_enabled boolean

exampletrue

Whether the user can use Box Sync

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

my_tags string array

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

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

role string

exampleadmin

The user’s enterprise role

Value is one of admin,coadmin,user

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

tracking_codes object array

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.

[tracking_codes].type string

exampletracking_code

tracking_code

Value is always tracking_code

[tracking_codes].name string

exampledepartment

The name of the tracking code, which must be preconfigured in the Admin Console

[tracking_codes].value string

exampleSales

The value of the tracking code

Response Example

{
  "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": "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"
    }
  ]
}