Search project text
POST
Search project text

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

environmentAlias
string
required

Query Parameters

projectID
string
required

The ID of the project to operate on.

Body

pattern
string
required

The word, phrase or ID to find. With regex, a JavaScript regular expression.

regex
boolean

Read pattern as a regular expression. Default false: literal text.

ignoreCase
boolean

Ignore case. Default true.

wholeWord
boolean

Match only where no letter, digit or underscore touches the match on either side. Default false.

resourceTypes
object[]

Search only these kinds of resource. Default: all of them.

limit
integer

Hits per page. Default 50.

offset
integer

Hits to skip: nextOffset from the previous page.

Response

200 - application/json

Returns one page of matches with the resource, field and line of each, the total match count, a count per resource type, whether more pages exist, and the kinds of text that are never searched.

hits
object[]
required
totalMatches
integer
required

Matches in everything searched, not only this page.

byResourceType
object
required

Matching lines per resource type, in everything searched.

hasMore
boolean
required
nextOffset
integer
incomplete
enum<boolean>

Present when the search did not read everything: it stopped at its time limit, or a regular expression read only the first 1,000 characters of a longer line. The counts cover only what it read.

Available options: true
notSearched
string[]
required

What this search never reads.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.