Skip to main content
GET
Read a file from a Box

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId
string
required

Public Box id returned by create/list/get box calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Query Parameters

path
string
required
encoding
enum<string>
default:utf8
Available options:
utf8,
base64

Response

200 - application/json

File contents.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "file.read"
success
boolean
required
path
string
required
encoding
enum<string>
required
Available options:
utf8,
base64
size
integer
required
content
string
required