Skip to main content
GET
/
projects
/
{project_reference}
/
branches
/
{branchName}
/
files
List Branch Files
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/branches/{branchName}/files \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "path": "<string>",
      "content": "<string>",
      "type": "page",
      "size": 123,
      "updated_at": "<string>",
      "id": "<string>",
      "version_id": "<string>"
    }
  ],
  "page_info": {
    "self": "<string>",
    "first": null,
    "next": "<string>",
    "prev": "<string>"
  }
}

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 ID or slug

​
branchName
string
required

Branch name

Query Parameters

​
pattern
string
Maximum string length: 200
​
cursor
string
​
limit
number
default:100

Number of items per page (default: 100, max: 100)

Required range: 1 <= x <= 100
​
sort_by
enum<string>
default:updated_at
Available options:
path,
updated_at
​
sort_order
enum<string>
default:desc
Available options:
asc,
desc
​
fields
string

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

Example:

"(id,path,type,size)"

Response

Files from the branch (supports sparse fieldsets per Zalando #157)

​
data
object[]
required
​
page_info
object
required