Box APIs

Files

API explorer Documentation ↗Generate API tests Request tracking

Suggest a correction

Browse the recorded Box APIs and open their documentation.

Allow domain access

API versioning strategy

Ensure consistency with headers

API Calls

Language codes

Pagination

Marker-based Pagination

Offset-based Pagination

App Diagnostics Report

Errors

Token & URL Expiration

Permissions and errors

Rate Limits

Scopes

Versioning errors

Request extra fields

Sorting responses

Status codes

Suppress notifications

Types and formats

Supported APIs for Box Archive

Box API & SSO

Use a Token

Extract APIs overview and use cases

Hubs APIs use cases

Make an API call

Use the Metadata Query API

Use Postman to make API calls

Delete AI agent

Remove domain from list of allowed collaboration domains

Remove user from list of users exempt from domain restrictions

Remove collaboration

Remove comment

Remove device pin

Delete file request

Delete file

Remove classification from file

Remove Box Skill cards from file

Remove metadata instance from file

Permanently remove file

Remove file version

Remove watermark from file

Remove upload session

`Create upload session`

Delete folder lock

Delete folder

Remove classification from folder

Remove metadata instance from folder

Permanently remove folder

Remove watermark from folder

Remove user from group

Remove group

Delete Slack integration mapping

Delete Teams integration mapping

Remove legal hold policy

Unassign legal hold policy

Remove metadata cascade policy

Remove metadata taxonomy

Remove metadata taxonomy node

Remove metadata template

Delete retention policy

Remove retention policy assignment

Delete shield information barrier segment member by ID

Delete shield information barrier segment restriction by ID

Delete shield information barrier segment

Unassign storage policy

Unassign task

Remove task

Delete user

Delete user avatar

Remove email alias

Remove web link

Permanently remove web link

Remove webhook

Get AI agent default configuration

List AI agents

Get AI agent by agent ID

Authorize user

List allowed collaboration domains

Get allowed collaboration domain

List users exempt from collaboration domain restrictions

Get user exempt from collaboration domain restrictions

List pending collaborations

Get collaboration

List all collections

Get collection by ID

List collection items

Get comment

Get device pin

List enterprise device pins

List user and enterprise events

Get file request

List file version legal holds

Get file version legal hold

List file version retentions

files under retention

Get retention on file

Get file information

Get shared link for file

List file app item associations

List file collaborations

List file comments

Download file

List metadata instances on file

Get classification on file

List Box Skill cards on file

Get metadata instance on file

List tasks on file

Get file thumbnail

Get trashed file

`GET /folders/:id/trash`

`GET /folders/trash/items`

List all file versions

Get file version

Get watermark on file

Get upload session

List parts

List folder locks

Get folder information

folder items

Get items in a folder

Get shared link for folder

List folder app item associations

List folder collaborations

List items in folder

Get a folder

List metadata instances on folder

Get classification on folder

Get metadata instance on folder

Get trashed folder

Get watermark for folder

List trashed items

Get group membership

List groups for enterprise

Get group

List group collaborations

List members of group

List Slack integration mappings

List Teams integration mappings

Get user invite status

List all legal hold policies

Get legal hold policy

List legal hold policy assignments

Get legal hold policy assignment

List previous file versions for legal hold policy assignment

List files with current file versions for legal hold policy assignment

List metadata cascade policies

Get metadata cascade policy

Get metadata taxonomies for namespace

Get metadata taxonomy by taxonomy key

List metadata taxonomy nodes

Get metadata taxonomy node by ID

Find metadata template by instance ID

List all metadata templates for enterprise

List all classifications

List all global metadata templates

Get metadata template by ID

List metadata template's options for taxonomy field

Get metadata template by name

List recently accessed items

List retention policies

Get retention policy

List retention policy assignments

Get retention policy assignment

Get file versions under retention

Get files under retention

Search for content

Find file for shared link

Find app item for shared link

Find folder for shared link

Find web link for shared link

List shield information barrier reports

Get shield information barrier report by ID

List shield information barrier segment members

Get shield information barrier segment member by ID

List shield information barrier segment restrictions

Get shield information barrier segment restriction by ID

List shield information barrier segments

Get shield information barrier segment with specified ID

List shield information barriers

Get shield information barrier with specified ID

List Box Sign requests

Get Box Sign request by ID

List Box Sign templates

Get Box Sign template by ID

List storage policies

Get storage policy

List storage policy assignments

Get storage policy assignment

Get task assignment

Get task

List task assignments

List terms of service user statuses

List terms of services

Get terms of service

List enterprise users

Get user

Get user avatar

List user's email aliases

List user's groups

Get current user

Get web link

Get shared link for web link

Get trashed web link

List all webhooks

Get webhook

List workflows

Download zip archive

Create zip download

Get zip download status

API Reference

Get events long poll endpoint

Preflight check before upload

Update metadata taxonomy

Update metadata taxonomy level

Update metadata taxonomy node

Create AI agent

Ask question

Extract metadata (freeform)

Extract metadata (structured)

Generate text

Add domain to list of allowed collaboration domains

Create user exemption from collaboration domain restrictions

Create collaboration

Create comment

Copy file request

Upload file

Restore file

Upload file version

Copy file

Add classification to file

Create Box Skill cards on file

Create metadata instance on file

Create upload session for existing file

Promote file version

Create upload session

Commit upload session

Create folder lock

Create folder

Restore folder

Copy folder

Add classification to folder

Create metadata instance on folder

Add user to group

Create group

Create jobs to terminate user group session

Create Slack integration mapping

Create Teams integration mapping

Create user invite

Create legal hold policy

Assign legal hold policy

Create metadata cascade policy

Force-apply metadata cascade policy to folder

Query files/folders by metadata

Create metadata taxonomy

Create metadata taxonomy levels

Add metadata taxonomy level

Delete metadata taxonomy level

Create metadata taxonomy node

Create metadata template

Add initial classifications

Revoke access token

Request access token

authorize

Refresh access token

Create retention policy

Assign retention policy

Create shield information barrier report

Create shield information barrier segment member

Create shield information barrier segment restriction

Create shield information barrier segment

Create shield information barrier

Add changed status of shield information barrier with specified ID

Create Box Sign request

Cancel Box Sign request

Resend Box Sign request

Assign storage policy

Assign task

Create task

Create terms of service status for new user

Create terms of service

Create user

Add or update user avatar

Create email alias

Create jobs to terminate users session

Create web link

Restore web link

Create webhook

Starts workflow based on request body

Update AI agent

Update collaboration

Update comment

Update file request

Update file

Add shared link to file

Remove shared link from file

Update shared link on file

Update classification on file

Update Box Skill cards on file

Update metadata instance on file

Restore file version

Apply watermark to file

Upload part of file

Update folder

Add shared link to folder

Remove shared link from folder

Update shared link on folder

Update classification on folder

Update metadata instance on folder

Apply watermark to folder

Update group membership

Update group

Update Slack integration mapping

Update Teams integration mapping

Update legal hold policy

Add classification

Update classification

Update metadata template

Update retention policy

Update shield information barrier segment with specified ID

Update all Box Skill cards on file

Update storage policy assignment

Update task assignment

Update task

Update terms of service status for existing user

Update terms of service

Update user

Transfer owned folders

Update web link

Add shared link to web link

Remove shared link from web link

Update shared link on web link

Update webhook

Access token

AI agent for question requests

AI agent for extract requests

AI agent for structured extract request

AI agent reference

AI agent for text generation requests

AI extract response

AI extract structured response

AI agents list

AI response

AI response (Full)

AI agent

AI agent (Full)

AI agent capability ask request

AI agent capability ask

AI agent capability extract request

AI agent capability extract

AI agent capability text generation request

AI agent capability text generation

App item

App item association

App item associations

Classification

Classification Template

Collaboration

Allowed collaboration domains

Allowed collaboration domain

Allowed collaboration domains user exemption

Allowed collaboration domains user exemptions

Collaborations

Collection

Collections

Comment

Comment (Base)

Comment (Full)

Comments

Conflict error

Device pinner

Device pinners

Email alias

Email aliases

Event

Events

File

File (Base)

File (Full)

File (Mini)

File Request

File version legal hold

File version legal holds

File version retention

File version retentions

File versions

File versions on hold

Files

Files on hold

Folder

Folder (Base)

Folder (Full)

Folder (Mini)

Folder Lock

Folder Locks

Group

Group (Base)

Group (Full)

Group (Mini)

Group membership

Group memberships

Groups

Integration mapping Slack

Integration mapping Teams

Integration mappings Slack

Integration mappings Teams

Invite

Items

Keyword Skill Card

Legal hold policies

Legal hold policy

Legal hold policy (Mini)

Legal hold policy assignment

Legal hold policy assignment (Base)

Legal hold policy assignments

Metadata instance

Metadata instance (Base)

Metadata instance (Full)

Metadata cascade policies

Metadata cascade policy

Metadata filter

Metadata query search results

Metadata taxonomies

Metadata taxonomy

Metadata taxonomy level

Metadata taxonomy levels

Metadata taxonomy node

Metadata taxonomy nodes

Metadata template

Metadata templates

Metadata instances

OAuth 2.0 error

Real-time servers

Recent item

Retention policies

Retention policy

Retention policy (Base)

Retention policy (Mini)

Retention policy assignment

Retention policy assignments

Search Result (including Shared Link)

Search Results

Search Results (including Shared Links)

Session termination message

Shield information barrier

Shield information barrier (Base)

Shield information barrier reference

Shield information barrier report

Shield information barrier report (Base)

Shield information barrier report details

List of Shield Information Barrier Reports

Shield information barrier segment

Shield information barrier segment member

Shield information barrier segment member (Base)

Shield information barrier segment member (Mini)

List of Shield Information Barrier Segment Members

Shield information barrier segment restriction

Shield information barrier segment restriction (Base)

Shield information barrier segment restriction (Mini)

List of Shield Information Barrier Segment Restrictions

List of Shield Information Barrier Segments

List of Shield Information Barriers

Box Sign request

Box Sign requests

Box Sign template

Box Sign templates

Skills metadata instance

Status Skill Card

Storage policies

Storage policy

Storage policy (Mini)

Storage policy assignment

Storage policy assignments

Task

Task assignment

Task assignments

Tasks

Terms of service

Terms of service (Base)

Terms of service user status

Terms of services

Terms of service user statuses

Timeline Skill Card

Transcript Skill Card.

Trashed File

Trashed File (Restored)

Trashed Folder

Trashed Folder (Restored)

Trashed Web Link

Trashed Web Link (Restored)

Upload part

Upload part (Mini)

Upload parts

Upload session

Upload URL

Uploaded part

User

User (Base)

User (Full)

User (Mini)

User avatar

User (Collaborations)

User (Integration Mappings)

Users

Watermark

Web link

Web link (Base)

Web link (Mini)

Webhook

Webhook (Mini)

Webhooks

Workflow

Workflow (Mini)

Workflows

Zip download

Zip download status

Delete archive

Archive API Guide

Delete Box Doc Gen template

Remove Box Hub collaboration

Delete Box Hub

Delete single shield list by shield list id

List archives

Get Box Doc Gen jobs by batch ID

List all Box Doc Gen jobs

Get Box Doc Gen job by ID

Get list of all Box Doc Gen jobs for template

List Box Doc Gen templates

Get Box Doc Gen template by ID

List all Box Doc Gen template tags in template

Get enterprise configuration

List all Box Hubs for requesting enterprise

Get Box Hub collaborations

Get Box Hub collaboration by collaboration ID

Get Box Hub items

List all Box Hubs

Get Box Hub information by ID

Get all shield lists in enterprise

Get single shield list by shield list id

Create archive

Generate document using Box Doc Gen template

Create Box Doc Gen template

Submit job to delete external users

Create Box Hub collaboration

Create Box Hub

Copy Box Hub

Manage Box Hub items

Create shield list

Update archive

Update Box Hub collaboration

Update Box Hub information by ID

Update shield list

Archive

Archives

Box Doc Gen batch (Base)

Box Doc Gen job

Box Doc Gen job (Base)

Box Doc Gen job (Full)

Box Doc Gen jobs

Box Doc Gen jobs (Full)

Box Doc Gen template tag

Box Doc Gen tags

Box Doc Gen tags processing message

Box Doc Gen template

Box Doc Gen templates

Enterprise configuration

Enterprise configuration content and sharing

Enterprise configuration security

Enterprise configuration shield

Enterprise configuration user settings

External Users Submit Delete Job Response

Box Hub

Box Hub (Base)

Box Hub Collaboration

Box Hub Collaborations

Box Hub Item

Box Hub Items

Box Hub Items Manage Response

Box Hubs

Shield List

Shield List (Mini)

Shield List Content (Country)

Shield List Content (Domain)

Shield List Content (Email)

Shield List Content (Integration)

Shield List Content (IP)

List of Shield Lists

API Basics