Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

User (Mini)

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

A mini representation of a user, as can be returned when nested within other resources.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the mini variant are generally returned when the resource is nested within the response for another resource.

string
11446498

The unique identifier for this user.

string
user

The value will always be user.

Value is always user

string (email)
ceo@example.com

The primary email address of this user.

string
Aaron Levie
50

The display name of this user.

Response Example

{
  "id": "11446498",
  "type": "user",
  "login": "ceo@example.com",
  "name": "Aaron Levie"
}