Ctrl K

List Responses

Published Mar 25, 2024

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

Script typeform Verified

Use in Windmill

The script

Submitted by hugo697 Bun

Verified 398 days ago

All edits

Permalink

import { createClient } from '@typeform/api-client'

type Typeform = {
	token: string
	baseUrl: string
}

export async function main(
	resource: Typeform,
	data: {
		formId: string
		pageSize?: number
		since?: string
		until?: string
		after?: string
		before?: string
		ids?: string[]
		fields?: string[]
		completed?: boolean
		sort?: string
	}
) {
	const typeformAPI = createClient({
		token: resource.token,
		apiBaseUrl: resource.baseUrl
	})

	return await typeformAPI.responses.list({
		uid: data.formId,
		pageSize: data.pageSize ?? 10,
		since: data.since,
		until: data.until,
		after: data.after,
		before: data.before,
		ids: data.ids,
		fields: data.fields,
		completed: data.completed,
		sort: data.sort
	})
}


`1`	`import { createClient } from '@typeform/api-client'`
`2`
`3`	`type Typeform = {`
`4`	`token: string`
`5`	`baseUrl: string`
`6`	`}`
`7`
`8`	`export async function main(`
`9`	`resource: Typeform,`
`10`	`data: {`
`11`	`formId: string`
`12`	`pageSize?: number`
`13`	`since?: string`
`14`	`until?: string`
`15`	`after?: string`
`16`	`before?: string`
`17`	`ids?: string[]`
`18`	`fields?: string[]`
`19`	`completed?: boolean`
`20`	`sort?: string`
`21`	`}`
`22`	`) {`
`23`	`const typeformAPI = createClient({`
`24`	`token: resource.token,`
`25`	`apiBaseUrl: resource.baseUrl`
`26`	`})`
`27`
`28`	`return await typeformAPI.responses.list({`
`29`	`uid: data.formId,`
`30`	`pageSize: data.pageSize ?? 10,`
`31`	`since: data.since,`
`32`	`until: data.until,`
`33`	`after: data.after,`
`34`	`before: data.before,`
`35`	`ids: data.ids,`
`36`	`fields: data.fields,`
`37`	`completed: data.completed,`
`38`	`sort: data.sort`
`39`	`})`
`40`	`}`
`41`