How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Box Users API

Box API supports a variety of users,ranging from real employeeslogging in with their Managed User account,to applications using App Users to drive powerfulautomation workflows.

Box Users API is one of 81 APIs that Box publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 9 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.box.com/2.0.

15 operations 9 paths 13 schemas 3 DELETE6 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://account.box.com/api/oauth2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Box Users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 15

Box API supports a variety of users, ranging from real employees logging in with their Managed User account, to applications using App Users to drive powerful automation workflows.

GET
/users
Box List enterprise users
get_users 8 params → 200default
POST
/users
Box Create user
post_users 1 param body → 201default
GET
/users/me
Box Get current user
get_users_me 1 param → 200default
GET
/users/{user_id}
Box Get user
get_users_id 2 params → 200default
PUT
/users/{user_id}
Box Update user
put_users_id 2 params body → 200400403default
DELETE
/users/{user_id}
Box Delete user
delete_users_id 3 params → 204default
PUT
/users/{user_id}/folders/0
Box Transfer owned folders
put_users_id_folders_0 3 params body → 200403default
POST
/users/terminate_sessions
Box Create jobs to terminate users session
post_users_terminate_sessions body → 202400403404429500503default
GET
/users/{user_id}/avatar
Box Get user avatar
get_users_id_avatar 1 param → 200default
POST
/users/{user_id}/avatar
Box Add or update user avatar
post_users_id_avatar 1 param body → 200201400403404default
DELETE
/users/{user_id}/avatar
Box Delete user avatar
delete_users_id_avatar 1 param → 204403404default
GET
/users/{user_id}/email_aliases
Box List user's email aliases
get_users_id_email_aliases 1 param → 200default
POST
/users/{user_id}/email_aliases
Box Create email alias
post_users_id_email_aliases 1 param body → 201default
DELETE
/users/{user_id}/email_aliases/{email_alias_id}
Box Remove email alias
delete_users_id_email_aliases_id 2 params → 204default
GET
/users/{user_id}/memberships
Box List user's groups
get_users_id_memberships 3 params → 200default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ClientError_3 (7 properties), ClientError (7 properties), ClientError_2 (7 properties), TrackingCode (3 properties). Each schema is shown below with its type and property counts.

User
object
A standard representation of a user, as returned from any user API endpoints by default
TrackingCode
object
Tracking codes allow an admin to generate reports from the admin console and assign an attribute to a specific group of users. This setting must be enabled for…
3 properties
ClientError
object
A generic error
7 properties
User--Mini
object
A mini representation of a user, as can be returned when nested within other resources.
Users
object
A list of users.
User--Base
object
A mini representation of a user, used when nested within another resource.
2 properties 2 required
User--Full
object
A full representation of a user, as can be returned from any user API endpoint.
ClientError_2
object
A generic error
7 properties
Folder--Full
object
A full representation of a folder, as can be returned from any folder API endpoints by default
ClientError_3
object
A generic error
7 properties
UserAvatar
object
A resource holding URLs to the avatar uploaded to a Box application.
1 property
EmailAliases
object
A list of email aliases
2 properties
GroupMemberships
object
A list of group memberships.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-users-api-openapi.yml Raw ↑

Other APIs Box publishes across the network.

Box Authorization API
Box Authorize API
Box Classifications API
Box Classifications on Files API
Box Classifications on Folders API
Box Collaboration Whitelist Entries API
Box Collaboration Whitelist Exempt Targets API
Box Collaborations API
Box Collaborations (List) API
Box Collections API
Box Comments API
Box Device Pinners API
Where this information came from

This is an independent, third-party profile of Box Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.