Skip to main content
POST
Get app code files

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app whose code to read.

Query Parameters

branch_id
string

ID of the branch to work on, as returned by List branches. Omit it to work on the app's main branch.

Body

application/json

The files to read.

paths
string[]
required

Paths of up to 32 files, relative to the app root.

Required array length: 1 - 32 elements
Example:
max_bytes
integer
default:5242880

Most bytes of file text to return across all the files, up to 5242880 (5 MB).

Required range: x <= 5242880
Example:

1048576

Response

Each file's text, or why it couldn't be read.

The text of each file you asked for.

files
Files · object
required

Each file, keyed by its path relative to the app root.

Example: