View as Markdown
Typeform icon

Typeform ACTION

List Responses

Returns form responses and date and time of form landing and submission. See the docs here
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Typeform account once, then configure and run List Responses from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "typeform-list-responses",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    typeform: { authProvisionId: "apn_xxxxxxx" },
    formId: "Form",
    pageSize: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Responses inputs
Property Type Description
formId Form string
Unique ID for the form, which you can find in your form URL. For example, in the URL, https://mysite.typeform.com/to/u6nXL7, the form_id is u6nXL7.
Required Dynamic
pageSize Page size integer
Maximum number of responses. Maximum value is 1000. If your typeform has more than 1000 responses, use the since/until or before/after parameters to narrow the scope of your request.
Optional
since Since string
Limit request to responses submitted since the specified date and time. Could be passed as int (timestamp in seconds) or in ISO 8601 format, UTC time, to the second, with T as a delimiter between the date and time (2020-03-20T14:00:59).
Optional
until Until string
Limit request to responses submitted until the specified date and time. Could be passed as int (timestamp in seconds) or in ISO 8601 format, UTC time, to the second, with T as a delimiter between the date and time (2020-03-20T14:00:59).
Optional
after After string
Limit request to responses submitted after the specified token. Could not be used together with sort parameter, as it sorts responses in the order that the system processed them (submitted_at). This ensures that you can traverse the complete set of responses without repeating entries.
Optional
before Before string
Limit request to responses submitted before the specified token. Could not be used together with sort parameter, as it sorts responses in the order that the system processed them (submitted_at). This ensures that you can traverse the complete set of responses without repeating entries.
Optional
includedResponseIds Included response IDs string[]
Limit request to the specified response_id values. Use a comma-separated list to specify more than one response_id value. Please bear in mind that if you set a list of included response ids you won't be able to use the list of excluded response ids
Optional Dynamic
excludedResponseIds Excluded response IDs string[]
Comma-separated list of response_ids to be excluded from the response. Please bear in mind that if you set a list of excluded response ids you won't be able to use the list of included response ids
Optional Dynamic
completed Completed boolean
Limit responses only to those which were submitted. This parameter changes since/until filter, so if completed=true, it will filter by submitted_at, otherwise - landed_at.
Optional
sort Sort string
Responses order in {fieldID},{asc|desc} format. You can use built-in submitted_at/landed_at field IDs or any field ID from your typeform, possible directions are asc/desc. Default value is submitted_at,desc.
Optional
query Query string
Limit request to only responses that include the specified string. The string will be escaped and it will be matched against all answers fields, hidden fields and variables values.
Optional
fields Fields string[]
Show only specified fields in answers section. If response does not have answers for specified fields, there will be null. Use a comma-separated list to specify more than one field value.
Optional Dynamic
answeredFields Answered fields string[]
Limit request to only responses that include the specified fields in answers section. Use a comma-separated list to specify more than one field value - response will contain at least one of the specified fields.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
typeform-list-responses
Version
0.0.3
App
Typeform
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes