Skip to main content
POST
Search branch files (text)

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

Body

application/json
query
string
required

Search query (text or regex pattern)

pattern
string

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

is_regex
boolean

Treat query as regex (default: false)

case_sensitive
boolean

Case sensitive search (default: false)

max_results
integer

Maximum matching files, integer 1-100 (default: 50).

Required range: 1 <= x <= 100

Response

Search results

results
object[]
required
total_files
number
required