Skip to main content
GET
Search a website's files

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

websiteId
string
required

Query Parameters

companyId
string
required

Company ID that owns the website

pattern
string
required

Regular expression to search for, matched line by line.

glob
string

Only search paths matching this glob, e.g. /pages/**/*.html

caseInsensitive
boolean

Ignore case when matching.

contextLines
integer

Lines of context to show around each match.

filesOnly
boolean

Return only the paths of matching files.

branch
string

Review branch to read from or write to. Omit (or "main") to read the live site. To propose fixes, write files to a NEW branch name (e.g. "seo-optimizer-2026-09-03") — the branch is created on first write and is reviewed and approved by the owner. Writing to "main" is refused.

Response

Matching lines or files

results
string

Matching lines as "path:line:text" (context lines use "-"), or matching paths when filesOnly is set. Results are capped; narrow the pattern or glob if they are truncated.