Search responses with the Typeform API

Searches the responses of a form by answer values, tags, hidden fields, metadata or submission time, all conditions together. Use it over List responses to filter by an answer. For the next page, pass the response_id of the last item as before_response_id.

Identifier
typeform_search_responses

The request

POST https://connect.reportei.com/api/tools/typeform_search_responses/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "form_id": "<form_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
form_idstringYesId of the form, from List forms or from the form URL: u6nXL7 in https://mysite.typeform.com/to/u6nXL7.
filter_groupobjectNoConditions that must all match.
response_typearrayNoResponse states to return, completed by default.
sizeintegerNoResponses per page, 25 by default and up to 1000.
sortarrayNoSort clauses as field,direction: a field id from Get form or submitted_at, staged_at or landed_at, then asc or desc. Cannot be combined with the cursors.
before_response_idstringNoPagination cursor: a response_id from Search responses, for the responses submitted before it.
after_response_idstringNoPagination cursor: a response_id from Search responses, for the responses submitted after it.
querystringNoOnly responses whose answers, hidden fields or variables contain this exact phrase.
fieldsarrayNoField ids from Get form to keep in the answers. The other answers come back as null.
answered_fieldsarrayNoField ids from Get form: only responses that answered at least one of them.

Supported connections

Your customer connects their Typeform account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/typeform, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/typeform_search_responses. It becomes your agent's tool definition with no conversion.

Other Typeform tools

See all 9 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.