Skip to main content
GET
List project files

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.

Query Parameters

ref
string

Content to address: main, branch:<name-or-id>, release:<version> or env:<name>. Canonical replacement for branch and branch_id.

Example:

"branch:feature-x"

branch
string

Branch name or ID. Legacy alias for ref=branch:<value>.

Example:

"feature-x"

branch_id
string<uuid>

Branch ID. Legacy alias for ref=branch:<uuid>.

pattern
string

File pattern filter (for example, *.tsx).

Maximum string length: 1024
cursor
string

Cursor for pagination

limit
integer
default:20

Files per page. At most 100 when the listing includes content, and at most 1000 when fields excludes content.

Required range: 1 <= x <= 1000
Example:

20

sort_by
enum<string>
default:updated_at

Sort by path or last update time (default updated_at).

Available options:
path,
updated_at
sort_order
enum<string>
default:desc

Sort order.

Available options:
asc,
desc
fields
string

Response fields to include or exclude. Examples: (id,name), (id,files(path)), and !(content).

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

"(id,path,type,size)"

Response

Paginated list of files with selectable response fields.

data
object[]
required
page_info
object
required

Hypermedia links for resource navigation