Skip to content


Repository files navigation

Box OpenAPI 3.0 Specification

CI Project Status

This repository contains the build system for the Box OpenAPI 3.0 Specification (OAS3) of the Box Platform API.

Note: Due to changes in API schema development process, this repository is currently frozen. This means we are not actively contributing to the repository, apart from necessary fixes and improvements that help us to put the new process in place even faster. You can still use the raw sources for specification available in the Download section.


The main branch of this repository only contains the raw source for the specification. For a combined, resolved version please have a look at the following builds.

OpenAPI (en) OpenAPI (jp)

Swagger (en) Swagger (jp)

Swagger 2.0

The older and incomplete Swagger 2.0 specification is still available on the Swagger 2.0 branch.


  • If you notice that the content requires improvements or you feel that some information is missing add a new GitHub issue and describe the issue.
  • If you are a Boxer, create a Developer Documentation ticket or use the #dev-docs-feedback Slack channel for assistance.

Usage & License

Copyright 2020 Box, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.