Skip to main content
GET
Get Project File

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required

Project slug, UUID, or domain

file_path
string
required

File path or UUID (URL-encoded, e.g., pages%2Findex.mdx)

Query Parameters

branch
string

Branch name or ID (omit for main branch)

fields
string

Sparse fieldset filter per Zalando #157. Examples: (id,name), (id,files(path)), !(content)

Pattern: ^!?\([^)]*\)$
Example:

"(id,path,type,size)"

Response

File content with metadata (supports sparse fieldsets per Zalando #157)

path
string
required
content
string
required
size
number
required
type
enum<string>
required
Available options:
page,
function,
component,
file
updated_at
string
required
id
string
version_id
string
checksum
string | null

Hypermedia links for resource navigation