Manage Applications

    User

    A full representation of a user, as can be returned from any user API endpoint.

    Base
    Mini
    Standard

    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 object

    string
    user

    Value is always "user"

    string / email
    ceo@example.com

    The primary email address of this user

    string
    Aaron Levie50

    The display name of this user

    string
    900 Jefferson Ave, Redwood City, CA 94063255

    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
    CEO100

    The user’s job title

    string / ISO639-1-BOX
    en

    The user's preferred language

    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
    6509241374100

    The user’s phone number

    integer
    11345156112

    The user’s total available space amount in bytes

    integer
    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

    Full

    Response Example

    {
      "id": 11446498,
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com",
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "language": "en",
      "timezone": "Africa/Bujumbura",
      "space_amount": 11345156112,
      "space_used": 1237009912,
      "max_upload_size": 2147483648,
      "status": "active",
      "job_title": "CEO",
      "phone": 6509241374,
      "address": "900 Jefferson Ave, Redwood City, CA 94063",
      "avatar_url": "https://www.box.com/api/avatar/large/181216415",
      "role": "admin",
      "tracking_codes": [
        {
          "type": "tracking_code",
          "name": "department",
          "value": "Sales"
        }
      ],
      "can_see_managed_users": true,
      "is_sync_enabled": true,
      "is_external_collab_restricted": true,
      "is_exempt_from_device_limits": true,
      "is_exempt_from_login_verification": true,
      "enterprise": {
        "id": 11446498,
        "type": "enterprise",
        "name": "Acme Inc."
      },
      "my_tags": [
        "important"
      ],
      "hostname": "https://example.app.box.com/",
      "is_platform_access_only": true,
      "external_app_user_id": "my-app-user"
    }