Typeform
Interact with Typeform
Integrate Typeform into the workflow. Can retrieve responses, download files, and get form insights. Can be used in trigger mode to trigger a workflow when a form is submitted. Requires API Key.
| Parameter | Type | Required | Description |
|---|
formId | string | Yes | Typeform form ID (e.g., "abc123XYZ") |
apiKey | string | Yes | No description |
pageSize | number | No | No description |
before | string | No | No description |
after | string | No | No description |
since | string | No | Retrieve responses submitted after this date (e.g., "2024-01-01T00:00:00Z") |
until | string | No | Retrieve responses submitted before this date (e.g., "2024-12-31T23:59:59Z") |
completed | string | No | Filter by completion status (e.g., "true", "false", "all") |
| Parameter | Type | Description |
|---|
total_items | number | Total number of responses |
page_count | number | Total number of pages available |
items | array | Array of response objects with response_id, submitted_at, answers, and metadata |
| Parameter | Type | Required | Description |
|---|
formId | string | Yes | Typeform form ID (e.g., "abc123XYZ") |
responseId | string | Yes | Response ID containing the files (e.g., "resp_xyz789") |
fieldId | string | Yes | No description |
filename | string | Yes | No description |
inline | boolean | No | No description |
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
fileUrl | string | Direct download URL for the uploaded file |
file | file | Downloaded file stored in execution files |
contentType | string | MIME type of the uploaded file |
filename | string | Original filename of the uploaded file |
| Parameter | Type | Required | Description |
|---|
formId | string | Yes | Typeform form ID (e.g., "abc123XYZ") |
apiKey | string | Yes | No description |
| Parameter | Type | Description |
|---|
fields | array | Number of users who dropped off at this field |
↳ dropoffs | number | Number of users who dropped off at this field |
↳ id | string | Unique field ID |
↳ label | string | Field label |
↳ ref | string | Field reference name |
↳ title | string | Field title/question |
↳ type | string | Field type (e.g., short_text, multiple_choice) |
↳ views | number | Number of times this field was viewed |
form | object | Average completion time for this platform |
↳ platforms | array | Average completion time for this platform |
↳ average_time | number | Average completion time for this platform |
↳ completion_rate | number | Completion rate for this platform |
↳ platform | string | Platform name (e.g., desktop, mobile) |
↳ responses_count | number | Number of responses from this platform |
↳ total_visits | number | Total visits from this platform |
↳ unique_visits | number | Unique visits from this platform |
↳ summary | object | Overall average completion time |
↳ average_time | number | Overall average completion time |
↳ completion_rate | number | Overall completion rate |
↳ responses_count | number | Total number of responses |
↳ total_visits | number | Total number of visits |
↳ unique_visits | number | Total number of unique visits |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
search | string | No | Search query to filter forms by title (e.g., "Customer Feedback") |
page | number | No | No description |
pageSize | number | No | No description |
workspaceId | string | No | Filter forms by workspace ID (e.g., "ws_abc123") |
| Parameter | Type | Description |
|---|
total_items | number | Total number of forms in the account |
page_count | number | Total number of pages available |
items | array | Array of form objects with id, title, created_at, last_updated_at, settings, theme, and _links |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
formId | string | Yes | Form unique identifier (e.g., "abc123XYZ") |
| Parameter | Type | Description |
|---|
id | string | Form unique identifier |
title | string | Form title |
type | string | Form type (form, quiz, etc.) |
settings | object | Form settings including language, progress bar, etc. |
theme | object | Theme reference |
workspace | object | Workspace reference |
fields | array | Array of form fields/questions |
welcome_screens | array | Array of welcome screens (empty if none configured) |
thankyou_screens | array | Array of thank you screens |
created_at | string | Form creation timestamp (ISO 8601 format) |
last_updated_at | string | Form last update timestamp (ISO 8601 format) |
published_at | string | Form publication timestamp (ISO 8601 format) |
_links | object | Related resource links including public form URL |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
title | string | Yes | No description |
type | string | No | Form type (default: "form"). Options: "form", "quiz" |
workspaceId | string | No | Workspace ID to create the form in (e.g., "ws_abc123") |
fields | json | No | Array of field objects defining the form structure. Each field needs: type, title, and optional properties/validations |
settings | json | No | No description |
themeId | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Created form unique identifier |
title | string | title output from the tool |
type | string | Form type |
settings | object | Form settings object |
theme | object | Theme reference |
workspace | object | Workspace reference |
fields | array | Array of created form fields (empty if none added) |
welcome_screens | array | Array of welcome screens (empty if none configured) |
thankyou_screens | array | Array of thank you screens |
_links | object | Related resource links including public form URL |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
formId | string | Yes | Form unique identifier to update (e.g., "abc123XYZ") |
operations | json | Yes | Array of JSON Patch operations (RFC 6902). Each operation needs: op (add/remove/replace), path, and value (for add/replace) |
| Parameter | Type | Description |
|---|
message | string | Success confirmation message |
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
formId | string | Yes | Form unique identifier to delete (e.g., "abc123XYZ") |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the form was successfully deleted |
message | string | Deletion confirmation message |