Skip to main content

Typeform Component

Typeform is an online form builder that enables users to create interactive and engaging surveys, forms, and quizzes.

Component key: typeform

Changelog ↓

Description​

Typeform is an online form builder that enables users to create interactive and engaging surveys, forms, and quizzes.

Use the component to deploy forms and manage the responses in real time.

API Documentation​

The component was built using the Typeform API References

Connections​

OAuth 2.0​

To Generate an OAuth App:

  1. Log in to your account at Typeform.
  2. In the upper-left corner, click icon drop-down menu next to your organization name.
  3. Under Organization section, click Developer Apps.
  4. Click Register a new app.
  5. In the App Name field, type the name for your new app.
  6. In the App website field, type the complete URL for your app's homepage.
  7. In the Redirect URI(s) field, enter https://oauth2.prismatic.io/callback
  8. Click Register app.
  9. Enter the following into the connection configuration of your integration
    1. Scopes (Recommended): offline accounts:read forms:write forms:read images:write images:write images:read themes:write themes:read responses:read responses:write webhooks:read webhooks:write workspaces:read workspaces:write
    2. Client ID
    3. Client Secret
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Typeform

https://api.typeform.com/oauth/authorize
Client ID
Client Secret
Scopes

A comma-delimited set of one or more scopes to get the user's permission to access. Refer to https://www.typeform.com/developers/get-started/scopes/

offline accounts:read forms:write forms:read images:write images:write images:read themes:write themes:read responses:read responses:write webhooks:read webhooks:write workspaces:read workspaces:write
Token URL

The OAuth 2.0 Token URL for Typeform

https://api.typeform.com/oauth/token

Personal Token​

To Generate a Personal Access Token:

  1. Log in to your account at Typeform.
  2. In the upper-left corner, in the drop-down menu next to your username, click Account.
  3. In the left menu, click Personal tokens or here.
  4. Click Generate a new token.
  5. In the Token name field, type a name for the token to help you identify it.
  6. Choose needed scopes (API actions this token can perform - or permissions it has). See here for more details on scopes.
  7. Click Generate token.
  8. Enter the token value into the Personal Token field of the connection in your integration.
InputNotesExample
Personal Token

Personal Token for Typeform

Triggers​

Typeform Webhook Trigger​

Get notified when a project is created, updated, or deleted in a workspace. | key: formTrigger

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7
Form Response

True if you want to send full responses to the webhook. Otherwise, false.

Form Response Partial

True if you want to send partial responses to the webhook. Otherwise, false.

Secret

Will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.

phoenix

Data Sources​

Select Account Workspaces​

Allow a user to select one of their account workspaces | key: selectAccountWorkspaces | type: picklist

InputNotesExample
Account Id

The unique identifier of the item to retrieve.

123
Connection

{
  "result": [
    {
      "label": "My Workspace",
      "key": "a1b2c3"
    },
    {
      "label": "My Second Workspace",
      "key": "a1b2c323"
    }
  ]
}

Select Form​

Allow a user to select one of their forms | key: selectForm | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "Form title",
      "key": "PVdw1syM"
    },
    {
      "label": "My Other Form",
      "key": "PVdw1syMS"
    }
  ]
}

Select Workspaces​

Allow a user to select one of their workspaces | key: selectWorkspaces | type: picklist

InputNotesExample
Connection

{
  "result": [
    {
      "label": "My Workspace",
      "key": "a1b2c3"
    },
    {
      "label": "My Second Workspace",
      "key": "a1b2c323"
    }
  ]
}

Actions​

Create Account Workspace​

Create a workspace in a specific account. | key: createAccountWorkspace

InputNotesExample
Account Id

The unique identifier of the item to retrieve.

123
Connection
Workspace Name

The name of the workspace account to create.

My Workspace

{
  "data": {
    "account_id": "ABCD1234",
    "forms": [
      {
        "count": 12,
        "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
      }
    ],
    "id": "a1b2c3",
    "name": "My Workspace",
    "self": [
      {
        "href": "https://api.typeform.com/workspaces/a1b2c3"
      }
    ],
    "shared": false
  }
}

Create Form​

Create a form | key: createForm

InputNotesExample
Connection
CUI Settings

The CUI settings for the form.

{ "avatar": "https://images.typeform.com/images/4BKUhw8A9cSM" }
Fields

The fields for the form.

[ { "attachment": { "href": "https://www.youtube.com/watch?v=Uui3oT-XBxs", "properties": { "description": "Typeform Home documentary" }, "scale": 0.8, "type": "video" }, "properties": { "description": "Cool description for the date", "separator": "-", "structure": "DDMMYYYY" }, "ref": "nice_readable_date_reference", "title": "Date Title", "type": "date", "validations": { "required": false } }, { "layout": { "attachment": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM", "type": "image" }, "placement": "right", "type": "float" }, "properties": { "alphabetical_order": false, "choices": [ { "label": "Foo" }, { "label": "Bar" } ], "description": "Cool description for the dropdown", "randomize": false }, "ref": "nice_readable_dropdown_reference", "title": "Dropdown Title", "type": "dropdown", "validations": { "required": false } } ]
Hidden

The hidden fields for the form.

[ "id", "created_at", "last_updated_at" ]
Logic

The logic for the form.

[ { "actions": [ { "action": "jump", "condition": { "op": "equal", "vars": [ { "type": "field", "value": "nice_readable_number_reference" }, { "type": "constant", "value": 5 } ] }, "details": { "to": { "type": "field", "value": "nice_readable_rating_reference" } } }, { "action": "add", "condition": { "op": "is", "vars": [ { "type": "field", "value": "nice_readable_yes_no_reference" }, { "type": "constant", "value": true } ] }, "details": { "target": { "type": "variable", "value": "score" }, "value": { "type": "constant", "value": 5 } } } ], "ref": "nice_readable_yes_no_reference", "type": "field" } ]
Settings

The settings for the form.

{ "autosave_progress": true, "facebook_pixel": "4347295725729872", "free_form_navigation": false, "google_analytics": "UA-1111-22", "google_tag_manager": "GTM-43959999", "hide_navigation": false, "is_public": false, "language": "en", "meta": { "allow_indexing": true, "canva_design_id": "DAElrx6aq-A", "description": "Cool meta description", "image": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM" }, "title": "Meta title" }, "progress_bar": "percentage", "redirect_after_submit_url": "https://www.redirecttohere.com", "show_cookie_consent": false, "show_key_hint_on_choices": true, "show_number_of_submissions": false, "show_progress_bar": true, "show_question_number": true, "show_time_to_complete": true, "show_typeform_branding": false }
Thank You Screens

The thank you screens for the form.

[ { "attachment": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM", "type": "image" }, "properties": { "button_mode": "redirect", "button_text": "start", "redirect_url": "https://www.typeform.com", "share_icons": false, "show_button": true }, "ref": "nice-readable-thank-you-ref", "title": "Thank you Title" } ]
Theme

URL of the workspace to use for the typeform. If you don't specify a URL for the workspace, Typeform saves the form in the default workspace.

https://api.typeform.com/themes/qHWOQ7
Title

Title to use for the typeform.

My Title
Type

Type of the form.

Variables

The variables for the form.

{ "age": 28, "name": "typeform", "price": 10.59, "score": 0 }
Welcome Screens

The welcome screens for the form.

[ { "layout": { "attachment": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM", "properties": { "decorative": true }, "type": "image" }, "placement": "left", "type": "split", "viewport_overrides": { "small": { "type": "wallpaper" } } }, "properties": { "button_text": "start", "description": "Cool description for the welcome", "show_button": true }, "ref": "nice-readable-welcome-ref", "title": "Welcome Title" } ]
Workspace URL

URL of the workspace to use for the typeform. If you don't specify a URL for the workspace, Typeform saves the form in the default workspace.

https://api.typeform.com/workspaces/Aw33bz

{
  "data": {
    "id": "id",
    "title": "title",
    "language": "en",
    "fields": [
      {}
    ],
    "hidden": [
      "string"
    ],
    "variables": {
      "score": 0,
      "price": 0
    },
    "welcome_screens": [
      {
        "ref": "nice-readable-welcome-ref",
        "title": "Welcome Title",
        "properties": {
          "description": "Cool description for the welcome",
          "show_button": true,
          "button_text": "start"
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "thankyou_screens": [
      {
        "ref": "nice-readable-thank-you-ref",
        "title": "Thank you Title",
        "type": "type",
        "properties": {
          "show_button": true,
          "button_text": "start",
          "button_mode": "redirect",
          "redirect_url": "https://www.typeform.com",
          "share_icons": true
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "logic": [
      {
        "type": "type",
        "ref": "ref",
        "actions": [
          {
            "action": "action",
            "details": {
              "to": {
                "type": "type",
                "value": "value"
              },
              "target": {
                "type": "type",
                "value": "value"
              },
              "value": {
                "type": "type"
              }
            },
            "condition": {
              "op": "op",
              "vars": [
                {
                  "type": "type",
                  "value": {}
                }
              ]
            }
          }
        ]
      }
    ],
    "theme": {
      "href": "https://api.typeform.com/themes/Fs24as"
    },
    "workspace": {
      "href": "https://api.typeform.com/workspaces/Aw33bz"
    },
    "_links": {
      "display": "https://subdomain.typeform.com/to/abc123"
    },
    "settings": {
      "language": "language",
      "is_public": true,
      "autosave_progress": true,
      "progress_bar": "proportion",
      "show_progress_bar": true,
      "show_typeform_branding": true,
      "show_time_to_complete": true,
      "show_number_of_submissions": true,
      "show_cookie_consent": true,
      "show_question_number": true,
      "show_key_hint_on_choices": true,
      "hide_navigation": true,
      "meta": {
        "title": "title",
        "allow_indexing": true,
        "description": "description",
        "image": {
          "href": "href"
        }
      },
      "redirect_after_submit_url": "redirect_after_submit_url",
      "google_analytics": "google_analytics",
      "facebook_pixel": "facebook_pixel",
      "google_tag_manager": "google_tag_manager",
      "milestones": [
        {
          "field_ref": "field_ref",
          "status": "status",
          "reason": "reason"
        }
      ],
      "enrichment_in_renderer": {
        "toggle": true,
        "active": true
      }
    },
    "cui_settings": {
      "avatar": "https://images.typeform.com/images/4bcd3",
      "is_typing_emulation_disabled": true,
      "typing_emulation_speed": "fast"
    }
  }
}

Create or Update Webhook​

Create or Update a Webhook | key: createWebhook

InputNotesExample
Connection
Enabled

True if you want to send responses to the webhook immediately. Otherwise, false.

phoenix
Form Id

Unique ID for the form.

u6nXL7
Form Response

True if you want to send full responses to the webhook. Otherwise, false.

Form Response Partial

True if you want to send partial responses to the webhook. Otherwise, false.

Secret

Will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.

phoenix
Tag

Unique name you want to use for the webhook.

phoenix
URL

Webhook URL.

https://test.com

{
  "data": {
    "created_at": "2016-11-21T12:23:28.000Z",
    "enabled": true,
    "event_types": {
      "form_response": true,
      "form_response_partial": true
    },
    "form_id": "abc123",
    "id": "yRtagDm8AT",
    "tag": "phoenix",
    "updated_at": "2016-11-21T12:23:28.000Z",
    "url": "https://test.com",
    "verify_ssl": true
  }
}

Create Workspace​

Create a workspace. | key: createWorkspace

InputNotesExample
Connection
Workspace Name

The name of the workspace.

My Workspace

{
  "data": {
    "account_id": "ABCD1234",
    "forms": [
      {
        "count": 12,
        "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
      }
    ],
    "id": "a1b2c3",
    "name": "My Workspace",
    "self": [
      {
        "href": "https://api.typeform.com/workspaces/a1b2c3"
      }
    ],
    "shared": false
  }
}

Delete Form​

Delete a form. | key: deleteForm

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7

{
  "data": {
    "message": "Deleted successfully"
  }
}

Delete Instance Webhooks​

Delete all webhooks from a form for the instance url provided. | key: deleteAllInstanceWebhooks

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7
Instance URL

The instance URL to delete all webhooks from, if not provided, all webhooks from the current flow will be deleted.

https://test.com

{
  "data": "Deleted successfully"
}

Delete Response​

Delete responses to a form. | key: deleteResponses

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7
Included Response Ids

Comma-separated list of response_id values of the responses to delete. You can list up to 1000 tokens and choose to do so either in the request URL, or in its body.

123

{
  "data": {
    "message": "Deleted successfully"
  }
}

Delete Webhook​

Delete a webhook. | key: deleteWebhook

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7
Tag

Unique name you want to use for the webhook.

phoenix

{
  "data": {
    "message": "Deleted successfully"
  }
}

Delete Workspace​

Delete a workspace. | key: deleteWorkspace

InputNotesExample
Connection
Workspace Id

The workspace Id to delete.

123

{
  "data": {
    "message": "Deleted successfully"
  }
}

Get All Response Files​

Download a zip archive containing all files uploaded by respondents for the specified form ID. | key: getAllResponseFiles

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7

{
  "data": {
    "type": "Buffer",
    "data": [
      102,
      105,
      108,
      101,
      32,
      99,
      111,
      110,
      116,
      101,
      110,
      116
    ]
  }
}

Get File from Response​

Download an uploaded file knowing its form, response, field and name. | key: getFileFromResponse

InputNotesExample
Connection
Field Id

Unique ID for the file upload field

u6nXL7
Filename

Filename for the uploaded file

u6nXL7
Form Id

Unique ID for the form.

u6nXL7
Response Id

Unique ID for the response.

u6nXL7

{
  "data": {
    "type": "Buffer",
    "data": [
      102,
      105,
      108,
      101,
      32,
      99,
      111,
      110,
      116,
      101,
      110,
      116
    ]
  }
}

Get Form​

Retrieve a form. | key: getForm

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7

{
  "data": {
    "id": "id",
    "title": "title",
    "language": "en",
    "fields": [
      {}
    ],
    "hidden": [
      "string"
    ],
    "variables": {
      "score": 0,
      "price": 0
    },
    "welcome_screens": [
      {
        "ref": "nice-readable-welcome-ref",
        "title": "Welcome Title",
        "properties": {
          "description": "Cool description for the welcome",
          "show_button": true,
          "button_text": "start"
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "thankyou_screens": [
      {
        "ref": "nice-readable-thank-you-ref",
        "title": "Thank you Title",
        "type": "type",
        "properties": {
          "show_button": true,
          "button_text": "start",
          "button_mode": "redirect",
          "redirect_url": "https://www.typeform.com",
          "share_icons": true
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "logic": [
      {
        "type": "type",
        "ref": "ref",
        "actions": [
          {
            "action": "action",
            "details": {
              "to": {
                "type": "type",
                "value": "value"
              },
              "target": {
                "type": "type",
                "value": "value"
              },
              "value": {
                "type": "type"
              }
            },
            "condition": {
              "op": "op",
              "vars": [
                {
                  "type": "type",
                  "value": {}
                }
              ]
            }
          }
        ]
      }
    ],
    "theme": {
      "href": "https://api.typeform.com/themes/Fs24as"
    },
    "workspace": {
      "href": "https://api.typeform.com/workspaces/Aw33bz"
    },
    "_links": {
      "display": "https://subdomain.typeform.com/to/abc123"
    },
    "settings": {
      "language": "language",
      "is_public": true,
      "autosave_progress": true,
      "progress_bar": "proportion",
      "show_progress_bar": true,
      "show_typeform_branding": true,
      "show_time_to_complete": true,
      "show_number_of_submissions": true,
      "show_cookie_consent": true,
      "show_question_number": true,
      "show_key_hint_on_choices": true,
      "hide_navigation": true,
      "meta": {
        "title": "title",
        "allow_indexing": true,
        "description": "description",
        "image": {
          "href": "href"
        }
      },
      "redirect_after_submit_url": "redirect_after_submit_url",
      "google_analytics": "google_analytics",
      "facebook_pixel": "facebook_pixel",
      "google_tag_manager": "google_tag_manager",
      "milestones": [
        {
          "field_ref": "field_ref",
          "status": "status",
          "reason": "reason"
        }
      ],
      "enrichment_in_renderer": {
        "toggle": true,
        "active": true
      }
    },
    "cui_settings": {
      "avatar": "https://images.typeform.com/images/4bcd3",
      "is_typing_emulation_disabled": true,
      "typing_emulation_speed": "fast"
    }
  }
}

Get Webhook​

Retrieve a single webhook. | key: getWebhook

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7
Tag

Unique name you want to use for the webhook.

phoenix

{
  "data": {
    "created_at": "2016-11-21T12:23:28.000Z",
    "enabled": true,
    "event_types": {
      "form_response": true,
      "form_response_partial": true
    },
    "form_id": "abc123",
    "id": "yRtagDm8AT",
    "tag": "phoenix",
    "updated_at": "2016-11-21T12:23:28.000Z",
    "url": "https://test.com",
    "verify_ssl": true
  }
}

Get Workspace​

Retrieve a workspace. | key: getWorkspace

InputNotesExample
Connection
Workspace Id

The workspace Id to retrieve.

123

{
  "data": {
    "account_id": "ABCD1234",
    "forms": [
      {
        "count": 12,
        "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
      }
    ],
    "id": "a1b2c3",
    "name": "My Workspace",
    "self": [
      {
        "href": "https://api.typeform.com/workspaces/a1b2c3"
      }
    ],
    "shared": false
  }
}

List Account Workspaces​

Retrieve all workspaces you have access to within the specific account. | key: listAccountWorkspaces

InputNotesExample
Account Id

The unique identifier of the item to retrieve.

123
Connection
Fetch All

If true, it will fetch all the records ignoring the rest of the parameters.

false
Page

The page of results to retrieve.

1
Page Size

Number of results to retrieve per page. Default is 10. Maximum is 200.

50
Search

Returns items that contain the specified string.

My Search

{
  "data": {
    "items": [
      {
        "account_id": "ABCD1234",
        "forms": [
          {
            "count": 12,
            "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
          }
        ],
        "id": "a1b2c3",
        "name": "My Workspace",
        "self": [
          {
            "href": "https://api.typeform.com/workspaces/a1b2c3"
          }
        ],
        "shared": false
      }
    ],
    "page_count": 1,
    "total_items": 10
  }
}

List Forms​

Retrieves a list of JSON descriptions for all forms in your Typeform account (public and private). | key: listForms

InputNotesExample
Connection
Fetch All

If true, it will fetch all the records ignoring the rest of the parameters.

false
Order By

Order type.

Page

The page of results to retrieve.

1
Page Size

Number of results to retrieve per page. Default is 10. Maximum is 200.

50
Search

Returns items that contain the specified string.

My Search
Sort By

Field to sort the results by.

Workspace Id

Retrieve typeforms for the specified workspace.

123

{
  "data": {
    "items": [
      {
        "id": "id",
        "title": "title",
        "language": "en",
        "fields": [
          {}
        ],
        "hidden": [
          "string"
        ],
        "variables": {
          "score": 0,
          "price": 0
        },
        "welcome_screens": [
          {
            "ref": "nice-readable-welcome-ref",
            "title": "Welcome Title",
            "properties": {
              "description": "Cool description for the welcome",
              "show_button": true,
              "button_text": "start"
            },
            "attachment": {
              "type": "image",
              "href": {
                "image": {
                  "value": "https://images.typeform.com/images/4bcd3"
                },
                "Pexels": {
                  "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                },
                "Vimeo": {
                  "value": "https://vimeo.com/245714980"
                },
                "YouTube": {
                  "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                }
              },
              "scale": 0,
              "properties": {
                "description": "description"
              }
            },
            "layout": {
              "type": "float",
              "placement": "left",
              "attachment": {
                "type": "image",
                "href": {
                  "image": {
                    "value": "https://images.typeform.com/images/4bcd3"
                  },
                  "Pexels": {
                    "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                  },
                  "Vimeo": {
                    "value": "https://vimeo.com/245714980"
                  },
                  "YouTube": {
                    "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                  }
                },
                "scale": 0,
                "properties": {
                  "description": "description"
                }
              },
              "viewport_overrides": {
                "small": {
                  "type": "float",
                  "placement": "left"
                },
                "large": {
                  "type": "split",
                  "placement": "right"
                }
              }
            }
          }
        ],
        "thankyou_screens": [
          {
            "ref": "nice-readable-thank-you-ref",
            "title": "Thank you Title",
            "type": "type",
            "properties": {
              "show_button": true,
              "button_text": "start",
              "button_mode": "redirect",
              "redirect_url": "https://www.typeform.com",
              "share_icons": true
            },
            "attachment": {
              "type": "image",
              "href": {
                "image": {
                  "value": "https://images.typeform.com/images/4bcd3"
                },
                "Pexels": {
                  "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                },
                "Vimeo": {
                  "value": "https://vimeo.com/245714980"
                },
                "YouTube": {
                  "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                }
              },
              "scale": 0,
              "properties": {
                "description": "description"
              }
            },
            "layout": {
              "type": "float",
              "placement": "left",
              "attachment": {
                "type": "image",
                "href": {
                  "image": {
                    "value": "https://images.typeform.com/images/4bcd3"
                  },
                  "Pexels": {
                    "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                  },
                  "Vimeo": {
                    "value": "https://vimeo.com/245714980"
                  },
                  "YouTube": {
                    "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                  }
                },
                "scale": 0,
                "properties": {
                  "description": "description"
                }
              },
              "viewport_overrides": {
                "small": {
                  "type": "float",
                  "placement": "left"
                },
                "large": {
                  "type": "split",
                  "placement": "right"
                }
              }
            }
          }
        ],
        "logic": [
          {
            "type": "type",
            "ref": "ref",
            "actions": [
              {
                "action": "action",
                "details": {
                  "to": {
                    "type": "type",
                    "value": "value"
                  },
                  "target": {
                    "type": "type",
                    "value": "value"
                  },
                  "value": {
                    "type": "type"
                  }
                },
                "condition": {
                  "op": "op",
                  "vars": [
                    {
                      "type": "type",
                      "value": {}
                    }
                  ]
                }
              }
            ]
          }
        ],
        "theme": {
          "href": "https://api.typeform.com/themes/Fs24as"
        },
        "workspace": {
          "href": "https://api.typeform.com/workspaces/Aw33bz"
        },
        "_links": {
          "display": "https://subdomain.typeform.com/to/abc123"
        },
        "settings": {
          "language": "language",
          "is_public": true,
          "autosave_progress": true,
          "progress_bar": "proportion",
          "show_progress_bar": true,
          "show_typeform_branding": true,
          "show_time_to_complete": true,
          "show_number_of_submissions": true,
          "show_cookie_consent": true,
          "show_question_number": true,
          "show_key_hint_on_choices": true,
          "hide_navigation": true,
          "meta": {
            "title": "title",
            "allow_indexing": true,
            "description": "description",
            "image": {
              "href": "href"
            }
          },
          "redirect_after_submit_url": "redirect_after_submit_url",
          "google_analytics": "google_analytics",
          "facebook_pixel": "facebook_pixel",
          "google_tag_manager": "google_tag_manager",
          "milestones": [
            {
              "field_ref": "field_ref",
              "status": "status",
              "reason": "reason"
            }
          ],
          "enrichment_in_renderer": {
            "toggle": true,
            "active": true
          }
        },
        "cui_settings": {
          "avatar": "https://images.typeform.com/images/4bcd3",
          "is_typing_emulation_disabled": true,
          "typing_emulation_speed": "fast"
        }
      }
    ]
  }
}

List Responses​

Returns form responses and date and time of form landing and submission. | key: listResponses

InputNotesExample
Connection
Custom Query Params

Custom fields filter

key1=value1
Fetch All

If true, it will fetch all the records ignoring the rest of the parameters.

false
Form Id

Unique ID for the form.

u6nXL7
Page

The page of results to retrieve.

1
Page Size

Number of results to retrieve per page. Default is 10. Maximum is 200.

50
Search

Returns items that contain the specified string.

My Search

{
  "data": {
    "items": [
      {
        "answers": [
          {
            "field": {
              "id": "hVONkQcnSNRj",
              "ref": "my_custom_dropdown_reference",
              "type": "dropdown"
            },
            "text": "Job opportunities",
            "type": "text"
          },
          {
            "boolean": false,
            "field": {
              "id": "RUqkXSeXBXSd",
              "ref": "my_custom_yes_no_reference",
              "type": "yes_no"
            },
            "type": "boolean"
          },
          {
            "boolean": true,
            "field": {
              "id": "gFFf3xAkJKsr",
              "ref": "my_custom_legal_reference",
              "type": "legal"
            },
            "type": "boolean"
          },
          {
            "field": {
              "id": "JwWggjAKtOkA",
              "ref": "my_custom_short_text_reference",
              "type": "short_text"
            },
            "text": "Lian",
            "type": "text"
          },
          {
            "email": "lian1078@other.com",
            "field": {
              "id": "SMEUb7VJz92Q",
              "ref": "my_custom_email_reference",
              "type": "email"
            },
            "type": "email"
          },
          {
            "field": {
              "id": "pn48RmPazVdM",
              "ref": "my_custom_number_reference",
              "type": "number"
            },
            "number": 1,
            "type": "number"
          },
          {
            "field": {
              "id": "Q7M2XAwY04dW",
              "ref": "my_custom_number2_reference",
              "type": "number"
            },
            "number": 1,
            "type": "number"
          },
          {
            "field": {
              "id": "WOTdC00F8A3h",
              "ref": "my_custom_rating_reference",
              "type": "rating"
            },
            "number": 3,
            "type": "number"
          },
          {
            "field": {
              "id": "DlXFaesGBpoF",
              "ref": "my_custom_long_text_reference",
              "type": "long_text"
            },
            "text": "It's a big, busy city. I moved here for a job, but I like it, so I am planning to stay. I have made good friends here.",
            "type": "text"
          },
          {
            "field": {
              "id": "NRsxU591jIW9",
              "ref": "my_custom_opinion_scale_reference",
              "type": "opinion_scale"
            },
            "number": 1,
            "type": "number"
          },
          {
            "choices": {
              "labels": [
                "New York",
                "Tokyo"
              ]
            },
            "field": {
              "id": "PNe8ZKBK8C2Q",
              "ref": "my_custom_picture_choice_reference",
              "type": "picture_choice"
            },
            "type": "choices"
          },
          {
            "date": "2012-03-20T00:00:00Z",
            "field": {
              "id": "KoJxDM3c6x8h",
              "ref": "my_custom_date_reference",
              "type": "date"
            },
            "type": "date"
          },
          {
            "choice": {
              "label": "A friend's experience in Sydney"
            },
            "field": {
              "id": "ceIXxpbP3t2q",
              "ref": "my_custom_multiple_choice_reference",
              "type": "multiple_choice"
            },
            "type": "choice"
          },
          {
            "choices": {
              "labels": [
                "New York",
                "Tokyo"
              ]
            },
            "field": {
              "id": "abISxvbD5t1p",
              "ref": "my_custom_ranking_reference",
              "type": "ranking"
            },
            "type": "choices"
          },
          {
            "choice": {
              "label": "Tokyo"
            },
            "field": {
              "id": "k6TP9oLGgHjl",
              "ref": "my_custom_multiple_choice2_reference",
              "type": "multiple_choice"
            },
            "type": "choice"
          }
        ],
        "calculated": {
          "score": 2
        },
        "hidden": {},
        "landed_at": "2017-09-14T22:33:59Z",
        "landing_id": "21085286190ffad1248d17c4135ee56f",
        "metadata": {
          "browser": "default",
          "network_id": "respondent_network_id",
          "platform": "other",
          "referer": "https://user_id.typeform.com/to/lR6F4j",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/603.3.8 (KHTML, like Gecko) Version/10.1.2 Safari/603.3.8"
        },
        "response_id": "21085286190ffad1248d17c4135ee56f",
        "submitted_at": "2017-09-14T22:38:22Z",
        "token": "test21085286190ffad1248d17c4135ee56f",
        "variables": [
          {
            "key": "score",
            "number": 2,
            "type": "number"
          },
          {
            "key": "name",
            "text": "typeform",
            "type": "text"
          }
        ]
      }
    ],
    "page_count": 1,
    "total_items": 4
  }
}

List Webhooks​

Retrieve all webhooks for the specified Typeform. | key: listWebhooks

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7

{
  "data": {
    "items": [
      {
        "created_at": "2016-11-21T12:23:28.000Z",
        "enabled": true,
        "event_types": {
          "form_response": true,
          "form_response_partial": true
        },
        "form_id": "abc123",
        "id": "yRtagDm8AT",
        "tag": "phoenix",
        "updated_at": "2016-11-21T12:23:28.000Z",
        "url": "https://test.com",
        "verify_ssl": true
      }
    ]
  }
}

List Workspaces​

Retrieve all workspaces the user has access to. | key: listWorkspaces

InputNotesExample
Connection
Fetch All

If true, it will fetch all the records ignoring the rest of the parameters.

false
Page

The page of results to retrieve.

1
Page Size

Number of results to retrieve per page. Default is 10. Maximum is 200.

50
Search

Returns items that contain the specified string.

My Search

{
  "data": {
    "items": [
      {
        "account_id": "ABCD1234",
        "forms": [
          {
            "count": 12,
            "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
          }
        ],
        "id": "a1b2c3",
        "name": "My Workspace",
        "self": [
          {
            "href": "https://api.typeform.com/workspaces/a1b2c3"
          }
        ],
        "shared": false
      }
    ]
  }
}

Raw Request​

Send raw HTTP request to Typeform API | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/forms), The base URL is already included (https://api.typeform.com). For example, to connect to https://api.typeform.com/api/v3/forms, only /forms is entered in this field. e.g. /forms

/forms
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Update Form​

Update a form. | key: updateForm

InputNotesExample
Connection
Form Id

Unique ID for the form.

u6nXL7
Operations

Operations to perform on the data.

{
  "data": {
    "message": "Operations applied successfully"
  }
}

Update Workspace​

Update a workspace. | key: updateWorkspace

InputNotesExample
Connection
Workspace Id

The workspace Id to update.

123
Operations

Operations to perform on the data.

{
  "data": {
    "message": "Operations applied successfully"
  }
}

Changelog​

2025-10-02​

Added inline data sources for forms, workspaces, and account workspaces to enhance data selection capabilities.