Skip to main content
GET
Get branch file draft

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 that identifies the project.

branchName
string
required

Branch name

filePath
string
required

File path (URL-encoded, for example, pages%2Findex.mdx).

Response

Draft content with navigation links

path
string
required

Path of the source file.

content
string
required

Full pending draft body, including empty bodies. A draft without a readable full snapshot is not found.

updated_at
string
required

When the pending draft was last saved.

file_id
string

Id of the source file the pending draft belongs to.

version
integer

Current pending draft sequence; resets after commit/discard. Use as expected_draft_version for a guarded draft write.

Required range: x >= 1
entity_type
enum<string>

Canonical source-file type.

Available options:
page,
component,
function,
virtual_file

Hypermedia links to the draft and its file.