Skip to main content
GET
/
projects
/
{project_reference}
/
files
/
{file_path}
Get Project File
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/files/{file_path} \
  --header 'Authorization: Bearer <token>'
{
  "path": "<string>",
  "content": "<string>",
  "size": 123,
  "type": "page",
  "updated_at": "<string>",
  "id": "<string>",
  "version_id": "<string>",
  "checksum": "<string>",
  "_links": {}
}

Authorizations

​
Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

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)

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
​
_links
object

Hypermedia links for resource navigation