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 Legal Hold Policy Assignments API

A Legal Hold Policy Assignmentis a relation between a policy and custodian.In this case, as custodian can be a user, folder,file, or file version.

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

Tagged areas include Legal Hold Policy Assignments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 30 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.

6 operations 4 paths 30 schemas 1 DELETE4 GET1 POST

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 Legal Hold Policy Assignments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 6

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

Legal Hold Policy Assignments 6

A Legal Hold Policy Assignment is a relation between a policy and custodian. In this case, as custodian can be a user, folder, file, or file version.

GET
/legal_hold_policy_assignments
Box List legal hold policy assignments
get_legal_hold_policy_assignments 6 params → 200default
POST
/legal_hold_policy_assignments
Box Assign legal hold policy
post_legal_hold_policy_assignments body → 201default
GET
/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}
Box Get legal hold policy assignment
get_legal_hold_policy_assignments_id 1 param → 200default
DELETE
/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}
Box Unassign legal hold policy
delete_legal_hold_policy_assignments_id 1 param → 202default
GET
/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold
Box List current file versions for legal hold policy assignment
get_legal_hold_policy_assignments_id_files_on_hold 4 params → 200default
GET
/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold
Box List previous file versions for legal hold policy assignment
get_legal_hold_policy_assignments_id_file_versions_on_hold 4 params → 200default

Schemas 30

The contract defines 30 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), FileVersionLegalHold (6 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.
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
LegalHoldPolicy--Mini
object
A mini legal hold policy
2 properties 2 required
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
LegalHoldPolicyAssignment--Base
object
Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the F…
2 properties
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
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.
FileVersionLegalHold
object
File-Version-Legal-Hold is an entity representing all holds on a File Version.
6 properties
LegalHoldPolicyAssignment
object
Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the F…
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
FileVersionLegalHolds
object
A list of file version legal holds.
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…
LegalHoldPolicyAssignments
object
A list of legal hold policies assignments.
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
FileVersionLegalHolds_2
object
A list of file version legal holds.
ClientError_3
object
A generic error
7 properties
FileVersionLegalHolds_3
object
A list of file version legal holds.
LegalHoldPolicyAssignments_2
object
A list of legal hold policies assignments.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-legal-hold-policy-assignments-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 Legal Hold Policy Assignments 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.