Skip to main content
GET
Search for the record a question's field means

Authorizations

Authorization
string
header
required

Use your app's API key as the username, and leave the password blank

Path Parameters

connection_id
string<uuid>
required

ID of the connection

run_id
string<uuid>
required

ID of the workflow run

Query Parameters

field
string
required

The name of a record field of one of the prompt's choices, or a rows field's record column as <field>.<column> (records.list_id).

row
string

For a rows field's record column: the row's key, whose kinds says the list searched. Needed when the column's kind is null.

q
string
required

What the person typed: 2 to 100 characters, once trimmed.

Required string length: 2 - 100
prompt_token
string

The token of the prompt being answered, as links.search carries it. Refused with 409 prompt_changed once the run has asked again or moved on.

Response

The records like q, best first: at most 20, and none when nothing is.

data
object[]
required
Maximum array length: 20