Box · Schema
User
A standard representation of a user, as returned from any user API endpoints by default
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
JSON Schema
{
"$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": "[email protected]",
"description": "The email address to send the notifications to."
},
"is_confirmed": {
"type": "boolean",
"example": true,
"description": "Specifies if this email address has been confirmed."
}
}
}
}
}
]
}