search
Search
/api/v1/search
Search the names of binders and flows and the titles and text of steps, across everything the account can open.
At most 50 results per kind; truncated says there were more.
key
Required scope: read
Query parameters
-
qstring · requiredWhat to look for, 2 to 200 characters.
-
typesarray of string · optionalRestrict the search to some kinds of match:
binder,flow,step_title,step_text. Repeat the parameter for several.
Response
200
SearchResults
-
querystringThe query, as it was understood.
-
truncatedbooleanWhether there were more results than the 50 per kind returned.
-
bindersarray of SearchBinderThe binders whose name matches.
5 fields
-
idintegerId of the binder or flow.
-
namestringIts name.
-
patharray of stringThe names of what holds it, from the space down.
-
levelstringWhat the account may do with it.
-
closedbooleanWhether the account, a reader of it, finds it offline and cannot open it.
-
-
flowsarray of SearchFlowThe flows whose name or steps match.
7 fields
-
idintegerId of the binder or flow.
-
namestringIts name.
-
patharray of stringThe names of what holds it, from the space down.
-
levelstringWhat the account may do with it.
-
closedbooleanWhether the account, a reader of it, finds it offline and cannot open it.
-
name_matchedbooleanWhether the query was found in the name of the flow itself, and not only in its steps.
-
stepsarray of SearchStepThe steps of the flow that match.
6 fields
-
idintegerId of the step.
-
referencestringIts reference.
-
versionstringThe version of the flow the step belongs to.
-
matchedstringWhere the query was found.
-
titlestringIts title; empty for a reader when the author hid it.
-
excerptstringThe text around the match, as plain text.
-
-
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
422
A value is missing or malformed.
-
429
Too many requests;
Retry-Aftergives the seconds to wait.