Box · Schema

User

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

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile SharingBoxStorage

Properties

Name Type Description
created_at string When the user object was created
modified_at string When the user object was last modified
language string The language of the user, formatted in modified version of the [ISO 639-1](/guides/api-calls/language-codes) format.
timezone string The user's timezone
space_amount integer The user’s total available space amount in bytes
space_used integer The amount of space in use by the user
max_upload_size integer The maximum individual file size in bytes the user can have
status string The user's account status
job_title string The user’s job title
phone string The user’s phone number
address string The user’s address
avatar_url string URL of the user’s avatar image
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 addre
View JSON Schema on GitHub

JSON Schema

box-user-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "type": "object",
  "x-box-resource-id": "user",
  "x-box-variant": "standard",
  "description": "A standard representation of a user, as returned from any\nuser API endpoints by default",
  "allOf": [
    {
      "$ref": "#/components/schemas/User--Mini"
    },
    {
      "properties": {
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the user object was created",
          "example": "2012-12-12T10:53:43-08:00"
        },
        "modified_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the user object was last modified",
          "example": "2012-12-12T10:53:43-08:00"
        },
        "language": {
          "type": "string",
          "description": "The language of the user, formatted in modified version of the\n[ISO 639-1](/guides/api-calls/language-codes) format.",
          "example": "en"
        },
        "timezone": {
          "type": "string",
          "format": "timezone",
          "description": "The user's timezone",
          "example": "Africa/Bujumbura"
        },
        "space_amount": {
          "type": "integer",
          "format": "int64",
          "description": "The user\u2019s total available space amount in bytes",
          "example": 11345156112
        },
        "space_used": {
          "type": "integer",
          "format": "int64",
          "description": "The amount of space in use by the user",
          "example": 1237009912
        },
        "max_upload_size": {
          "type": "integer",
          "format": "int64",
          "description": "The maximum individual file size in bytes the user can have",
          "example": 2147483648
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "inactive",
            "cannot_delete_edit",
            "cannot_delete_edit_upload"
          ],
          "description": "The user's account status",
          "example": "active"
        },
        "job_title": {
          "type": "string",
          "description": "The user\u2019s job title",
          "maxLength": 100,
          "example": "CEO"
        },
        "phone": {
          "type": "string",
          "description": "The user\u2019s phone number",
          "maxLength": 100,
          "example": "6509241374"
        },
        "address": {
          "type": "string",
          "description": "The user\u2019s address",
          "maxLength": 255,
          "example": "900 Jefferson Ave, Redwood City, CA 94063"
        },
        "avatar_url": {
          "type": "string",
          "description": "URL of the user\u2019s avatar image",
          "example": "https://www.box.com/api/avatar/large/181216415"
        },
        "notification_email": {
          "type": "object",
          "description": "An alternate notification email address to which email\nnotifications are sent. When it's confirmed, this will be\nthe email address to which notifications are sent instead of\nto the primary email address.",
          "nullable": true,
          "properties": {
            "email": {
              "type": "string",
              "example": "notifications@example.com",
              "description": "The email address to send the notifications to."
            },
            "is_confirmed": {
              "type": "boolean",
              "example": true,
              "description": "Specifies if this email address has been confirmed."
            }
          }
        }
      }
    }
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/box-user"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.