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 (Collaborations)

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

A mini representation of a user, can be returned only when the status is pending.

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

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

string
11446498

The unique identifier for this user.

string
user

The value will always be user.

Value is always user

boolean
true

If set to false, the user is either deactivated or deleted.

string (email)
ceo@example.com

The primary email address of this user. If the collaboration status is pending, an empty string is returned.

string
Aaron Levie
50

The display name of this user. If the collaboration status is pending, an empty string is returned.

Response Example

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