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 Retention Policy Assignments API

A Retention Policy Assignment is a relationbetween a policy and folder or enterprise.Creating an assignment puts a retention onall the file versions that belong to that folder or enterprise.

Box Retention 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 Retention Policy Assignments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 5 paths, and defines 17 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 5 paths 17 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 Retention 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 5 paths, the API surfaces 6 operations — 1 DELETE, 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Retention Policy Assignments 6

A Retention Policy Assignment is a relation between a policy and folder or enterprise. Creating an assignment puts a retention on all the file versions that belong to that folder…

GET
/retention_policies/{retention_policy_id}/assignments
Box List retention policy assignments
get_retention_policies_id_assignments 5 params → 200400default
POST
/retention_policy_assignments
Box Assign retention policy
post_retention_policy_assignments body → 201400404409default
GET
/retention_policy_assignments/{retention_policy_assignment_id}
Box Get retention policy assignment
get_retention_policy_assignments_id 2 params → 200default
DELETE
/retention_policy_assignments/{retention_policy_assignment_id}
Box Remove retention policy assignment
delete_retention_policy_assignments_id 1 param → 204403404default
GET
/retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention
Box Get files under retention
get_retention_policy_assignments_id_files_under_retention 3 params → 200400default
GET
/retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention
Box Get file versions under retention
get_retention_policy_assignments_id_file_versions_under_retention 3 params → 200400default

Schemas 17

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

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.
FileVersion--Mini
object
A mini representation of a file version, used when nested within another resource.
File--Mini
objectnull
A mini representation of a file, used when nested under 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
RetentionPolicyAssignment
object
A retention assignment represents a rule specifying the files a retention policy retains. Assignments can retain files based on their folder or metadata, or ho…
8 properties 2 required
RetentionPolicy--Base
object
A base representation of a retention policy.
2 properties 2 required
FilesUnderRetention
object
A list of files under retention.
RetentionPolicyAssignments
object
A list of retention policy assignments.
User--Base
object
A mini representation of a user, used when nested within another resource.
2 properties 2 required
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
RetentionPolicy--Mini
object
A mini representation of a retention policy, used when nested within another resource.
ClientError_2
object
A generic error
7 properties
FilesUnderRetention_2
object
A list of files under retention.
ClientError_3
object
A generic error
7 properties
RetentionPolicyAssignment_2
object
A retention assignment represents a rule specifying the files a retention policy retains. Assignments can retain files based on their folder or metadata, or ho…
8 properties 2 required
FilesUnderRetention_3
object
A list of files under retention.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-retention-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 Retention 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.