# List Responses — Typeform

> Returns form responses and date and time of form landing and submission. See the docs here

- Key: `typeform-list-responses`
- Type: Action (Read-only)
- Version: 0.0.3
- App: Typeform (`typeform`) — https://pipedream.com/apps/typeform.md
- This page (HTML): https://pipedream.com/apps/typeform/actions/list-responses
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/typeform/actions/list-responses/list-responses.mjs

## Description

Returns form responses and date and time of form landing and submission. [See the docs here](https://developer.typeform.com/responses/reference/retrieve-responses/)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `formId` | `string` | Yes | 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. Options are loaded from the connected account. |
| `pageSize` | `integer` | No | 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. |
| `since` | `string` | No | 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). |
| `until` | `string` | No | 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). |
| `after` | `string` | No | 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. |
| `before` | `string` | No | 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. |
| `includedResponseIds` | `string[]` | No | 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 Options are loaded from the connected account. |
| `excludedResponseIds` | `string[]` | No | 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 Options are loaded from the connected account. |
| `completed` | `boolean` | No | 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. |
| `sort` | `string` | No | 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. |
| `query` | `string` | No | 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. |
| `fields` | `string[]` | No | 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. Options are loaded from the connected account. |
| `answeredFields` | `string[]` | No | 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. Options are loaded from the connected account. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "typeform",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "typeform-list-responses",
  arguments: {
    formId: "Form",
    pageSize: 10,
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "typeform-list-responses",
    "configured_props": {
      "typeform": { "authProvisionId": "apn_xxxxxxx" },
      "formId": "Form",
      "pageSize": 10
    }
  }'
```

---

- App: https://pipedream.com/apps/typeform.md · All apps: https://pipedream.com/apps