> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Typeform

> How to set up the Typeform connector, plus the actions and events that are available.

![Typeform](https://stackone-logos.com/api/typeform/filled/svg)

v1.4.0[See changelog](https://docs.stackone.com/connectors/typeform/changelog.md)

[36 actions](#actions) · [1 event](#events) · 2 auth methods

Surveys
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth2 · Connector Profile](https://docs.stackone.com/connectors/typeform/guides/connector-profile/oauth2.md)
>
> Create an OAuth application in Typeform to get client credentials

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/typeform/guides/connector-profile/personal-access-token.md)
>
> No app registration required. The token acts as the Typeform user who created it, limited to the scopes selected when it...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth2 · Link Account](https://docs.stackone.com/connectors/typeform/guides/link-account/oauth2.md)

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/typeform/guides/link-account/personal-access-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounts:read

forms:read

forms:write

images:read

images:write

responses:read

responses:write

themes:read

themes:write

workspaces:read

workspaces:write

No scopes found

36 actions

ActionDescriptionRequired scopes

List Forms`typeform_list_forms`

Retrieve all forms in your Typeform account

`forms:read`

Create Form`typeform_create_form`

Create a new typeform with fields, logic, and settings

`forms:write`

Get Form`typeform_get_form`

Retrieve a specific form by ID

`forms:read`

Update Form`typeform_update_form`

Update an existing form with PATCH operations

`forms:write`

Delete Form`typeform_delete_form`

Delete a form permanently

`forms:write`

Get Form Messages`typeform_get_form_messages`

Retrieve custom messages for a form

`forms:read`

List Responses`typeform_list_responses`

Retrieve responses for a specific form with advanced filtering and pagination

`responses:read`

Delete Responses`typeform_delete_responses`

Delete specific responses from a form (GDPR compliance)

`responses:write`

List Themes`typeform_list_themes`

Retrieve all themes in your Typeform account

`themes:read`

Create Theme`typeform_create_theme`

Create a new custom theme for forms

`themes:write`

Get Theme`typeform_get_theme`

Retrieve a specific theme by ID

`themes:read`

Update Theme`typeform_update_theme`

Update an existing theme (replaces entire theme definition)

`themes:write`

Patch Theme`typeform_patch_theme`

Partially update a theme (only provided fields are updated)

`themes:write`

Delete Theme`typeform_delete_theme`

Delete a custom theme

`themes:write`

List Images`typeform_list_images`

Retrieve all images in your Typeform account

`images:read`

Create Image`typeform_create_image`

Upload a new image via base64 or URL

`images:write`

Get Image`typeform_get_image`

Retrieve image metadata by ID

`images:read`

Delete Image`typeform_delete_image`

Delete an uploaded image

`images:write`

Get Background Image By Size`typeform_get_background_by_size`

Retrieve a background image in a specific size

`images:read`

Get Choice Image By Size`typeform_get_choice_image_by_size`

Retrieve a choice image in a specific size

`images:read`

Get Image By Size`typeform_get_image_by_size`

Retrieve a general image in a specific size

`images:read`

List Workspaces`typeform_list_workspaces`

Retrieve all workspaces in your Typeform account

`workspaces:read`

Create Workspace`typeform_create_workspace`

Create a new workspace to organize forms

`workspaces:write`

Get Workspace`typeform_get_workspace`

Retrieve a specific workspace by ID

`workspaces:read`

Delete Workspace`typeform_delete_workspace`

Delete a workspace

`workspaces:write`

Get Unified Credentials`typeform_unified_get_me`

Get unified credentials for the current Typeform connection.

`accounts:read`

List Unified Groups`typeform_unified_list_groups`

List unified groups in Typeform.

`workspaces:read`

Get Unified Group`typeform_unified_get_group`

Get a unified Typeform group (workspace) by id.

`workspaces:read`

Add Workspace Member`typeform_add_workspace_member`

Invite or add a member to a Typeform workspace by email.

`workspaces:write`

Remove Workspace Member`typeform_remove_workspace_member`

Remove a member from a Typeform workspace by email.

`workspaces:write`

List Unified Organizations`typeform_unified_list_organizations`

List the Typeform accounts that own the workspaces this connection can see.

`workspaces:read`

Get Unified Organization`typeform_unified_get_organization`

Get a Typeform account by id.

`workspaces:read`

List Unified Roles`typeform_unified_list_roles`

List unified roles in Typeform.

`accounts:read`

Get Unified Role`typeform_unified_get_role`

Get a unified Typeform role by id.

`accounts:read`

List Unified Users`typeform_unified_list_users`

List the members of every Typeform workspace the connection can see, one record per email.

`workspaces:read`

Get Unified User`typeform_unified_get_user`

Get a unified Typeform user by email.

`accounts:read``workspaces:read`

## Events

Tags

Select all
|
Clear

Forms

Responses

Webhooks

No tags found

1 event

EventDescriptionTags

Form Response Submitted`typeform_webhook_form_response`

Triggered when a respondent submits a Typeform form. The form\_response object contains the submission token, answers, an...

FormsResponsesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.