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

# Typeform

> Build beautiful, interactive forms that people love to fill out

Build beautiful, interactive forms that people love to fill out. Collect data, accept payments, and integrate with your favorite tools.

`typeform` · **35 tools** · **1 triggers**

## Connect it

```bash theme={"theme":"github-dark"}
run auth typeform
run auth typeform --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run typeform          # common commands
run typeform --all    # every command
```

```ts theme={"theme":"github-dark"}
import { typeform } from "@boxd/run";
```

## Common tools

| Tool                 | What it does                                                                                                   |
| -------------------- | -------------------------------------------------------------------------------------------------------------- |
| `create-form`        | Tool to create a new Typeform form with customizable fields, logic, and settings.                              |
| `get-about-me`       | Get information about the owner account in Typeform.                                                           |
| `get-form`           | Tool to retrieve a specific form's complete configuration including fields, logic, settings, and theme.        |
| `get-form-responses` | Tool to retrieve form responses from Typeform with filtering by date, pagination, search, and response type.   |
| `get-workspace`      | Tool to retrieve detailed information about a specific workspace including its name, forms, and team members.  |
| `list-forms`         | Tool to retrieve a list of all forms in your Typeform account with filtering, pagination, and sorting options. |
| `list-themes`        | Tool to retrieve a paginated list of themes in your Typeform account.                                          |
| `list-workspaces`    | Tool to retrieve all workspaces in a Typeform account with their IDs, names, form counts, and members.         |

<Accordion title="All 35 tools" icon="list">
  | Tool                       | What it does                                                                                                                                                       |
  | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | `create-account-workspace` | Tool to create a new workspace in a specific Typeform account.                                                                                                     |
  | `create-form`              | Tool to create a new Typeform form with customizable fields, logic, and settings.                                                                                  |
  | `create-image`             | Tool to upload a new image to your Typeform account via base64 encoding or URL.                                                                                    |
  | `create-or-update-webhook` | Tool to create a new webhook or update an existing one for a specified Typeform.                                                                                   |
  | `create-theme`             | Tool to create a new custom theme in Typeform with colors, fonts, background, and layout settings.                                                                 |
  | `create-workspace`         | Tool to create a new workspace in Typeform. Use when organizing forms into separate workspaces for teams or projects.                                              |
  | `delete-form`              | Tool to permanently delete a Typeform and all of its responses.                                                                                                    |
  | `delete-image`             | Tool to delete an image from your Typeform account. Use when you need to remove an image that is no longer needed.                                                 |
  | `delete-responses`         | Tool to delete specific responses from a Typeform by response IDs.                                                                                                 |
  | `delete-theme`             | Tool to delete a theme from your Typeform account. Use when you need to permanently remove a theme.                                                                |
  | `delete-webhook`           | Tool to delete a webhook configuration from a Typeform form.                                                                                                       |
  | `delete-workspace`         | Tool to delete a workspace from your Typeform account. Use when you need to remove a workspace.                                                                    |
  | `get-about-me`             | Get information about the owner account in Typeform.                                                                                                               |
  | `get-all-response-files`   | Tool to retrieve a compressed archive containing all files that respondents uploaded for a specified form.                                                         |
  | `get-background-by-size`   | Tool to retrieve a background image by size from Typeform. Use when you need to get a background image in a specific size (default, tablet, mobile, or thumbnail). |
  | `get-choice-image-by-size` | Tool to retrieve a choice image by size from Typeform. Use when you need to download images used in picture\_choice question options at specific sizes.            |
  | `get-form`                 | Tool to retrieve a specific form's complete configuration including fields, logic, settings, and theme.                                                            |
  | `get-form-messages`        | Tool to retrieve custom messages for a Typeform including button labels, error messages, and UI text.                                                              |
  | `get-form-responses`       | Tool to retrieve form responses from Typeform with filtering by date, pagination, search, and response type.                                                       |
  | `get-image-by-size`        | Tool to retrieve an image in a specific size from Typeform. Use when you need to get a Typeform image optimized for different display contexts...                  |
  | `get-theme`                | Tool to retrieve a specific theme's configuration including colors, fonts, and layout settings.                                                                    |
  | `get-webhook`              | Tool to retrieve a single webhook by specifying both the form ID and webhook tag.                                                                                  |
  | `get-workspace`            | Tool to retrieve detailed information about a specific workspace including its name, forms, and team members.                                                      |
  | `list-forms`               | Tool to retrieve a list of all forms in your Typeform account with filtering, pagination, and sorting options.                                                     |
  | `list-images`              | Tool to retrieve all images in your Typeform account in reverse-chronological order.                                                                               |
  | `list-themes`              | Tool to retrieve a paginated list of themes in your Typeform account.                                                                                              |
  | `list-webhooks`            | Tool to retrieve all webhooks associated with a specified typeform.                                                                                                |
  | `list-workspaces`          | Tool to retrieve all workspaces in a Typeform account with their IDs, names, form counts, and members.                                                             |
  | `patch-form`               | Tool to partially update a Typeform using JSON Patch operations.                                                                                                   |
  | `patch-theme`              | Tool to partially update a Typeform theme by ID. Updates only the specified properties while leaving other theme settings unchanged.                               |
  | `update-form`              | Tool to update an existing Typeform by completely replacing its configuration.                                                                                     |
  | `update-form-messages`     | Tool to update custom messages for form UI elements like buttons, errors, and placeholders in Typeform.                                                            |
  | `update-theme`             | Tool to update a theme's complete definition in Typeform. Use when you need to update all aspects of a theme including colors, fonts, and visual properties.       |
  | `update-workspace`         | Tool to update a workspace's name or manage team member access (add/remove members) in Typeform.                                                                   |
  | `upload-video`             | Initiate a video upload to Typeform by obtaining a signed upload URL.                                                                                              |
</Accordion>

## Triggers (1)

Subscribe with `.on(...)` in a script. A trigger with required configuration takes it as the second argument.

| Trigger           | Needs     | What fires it                                              |
| ----------------- | --------- | ---------------------------------------------------------- |
| New Form Response | `form_id` | Triggers when a respondent completes and submits the form. |

[Open Typeform in the console →](https://app.boxd.sh/integrations/detail/typeform)
