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 Collaborations API

Collaborations define access permissionsfor users and groups to files and folders,similar to access control lists.

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

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

This API exposes 5 operations across 2 paths, and defines 27 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.

5 operations 2 paths 27 schemas 1 DELETE2 GET1 POST1 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 Collaborations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Collaborations 5

Collaborations define access permissions for users and groups to files and folders, similar to access control lists.

GET
/collaborations/{collaboration_id}
Box Get collaboration
get_collaborations_id 2 params → 200default
PUT
/collaborations/{collaboration_id}
Box Update collaboration
put_collaborations_id 1 param body → 200204403default
DELETE
/collaborations/{collaboration_id}
Box Remove collaboration
delete_collaborations_id 1 param → 204default
POST
/collaborations
Box Create collaboration
post_collaborations 2 params body → 201403default
GET
/collaborations
Box List pending collaborations
get_collaborations 4 params → 200default

Schemas 27

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

Folder
object
A standard representation of a folder, as returned from any folder API endpoints by default
ClientError
object
A generic error
7 properties
FileVersion--Mini
object
A mini representation of a file version, used when nested within another resource.
Collaboration
object
Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or gr…
14 properties 2 required
FileVersion--Base
object
The bare basic representation of a file version, the minimal amount of fields returned when using the fields query parameter.
2 properties 2 required
User--Base
object
A mini representation of a user, used when nested within another resource.
2 properties 2 required
Group--Mini
object
Mini representation of a group, including id and name of group.
User--Mini
object
A mini representation of a user, as can be returned when nested within other resources.
Items
object
A list of files, folders, and web links in their mini representation.
File
object
A standard representation of a file, as returned from any file API endpoints by default
File--Mini
objectnull
A mini representation of a file, used when nested under another resource.
Metadata--Base
object
The base representation of a metadata instance.
4 properties
User--Collaborations
object
A mini representation of a user, can be returned only when the status is pending.
FileOrFolderScope
object
A relation between a resource (file or folder) and the scopes for which the resource can be accessed
2 properties
File--Full
object
A full representation of a file, as can be returned from any file API endpoints by default
TermsOfService--Base
object
The root-level record that is supposed to represent a single Terms of Service.
2 properties 2 required
Group--Base
object
A base representation of a group.
2 properties 2 required
Folder--Mini
object
A mini representation of a file version, used when nested under another resource.
WebLink--Mini
object
Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to f…
Metadata
object
An instance of a metadata template, which has been applied to a file or folder.
Folder--Base
object
The bare basic representation of a folder, the minimal amount of fields returned when using the fields query parameter.
3 properties 2 required
WebLink--Base
object
Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to f…
3 properties 2 required
WebLink
object
Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to f…
File--Base
objectnull
The bare basic representation of a file, the minimal amount of fields returned when using the fields query parameter.
3 properties 2 required
ClientError_2
object
A generic error
7 properties
Collaborations
object
A list of collaborations
Collaboration_2
object
Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or gr…
14 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-collaborations-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 (List) API
Box Collections API
Box Comments API
Box Device Pinners API
Box Domain Restrictions for Collaborations API
Where this information came from

This is an independent, third-party profile of Box Collaborations 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.