Formbricks integration: operations for AI agents
Formbricks connects to Type.com as an integration. This page lists the 122 operations documented for Claude and Codex in Type.com: 53 read, 40 write, 29 destructive.
About Formbricks
Formbricks is an open-source platform for building and managing surveys, enabling organizations to collect and analyze user feedback effectively.
Categories: Documents & Forms
How to connect Formbricks to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
122 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
122 operations listed.
Client API Display
- Write
Create Display
Create a new display for a valid survey ID. If a userId is passed, the display is linked to the user. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Write
Create Display
Create a new display for a valid survey ID. If a userId is passed, the display is linked to the user. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
Client API Environment
- Read
Get Workspace State
Retrieves the workspace state to be used in Formbricks SDKs. Note - Environments are deprecated. Use Workspace/workspaceId terminology. Cache Behavior: This endpoint uses server-side caching with a 5-minute TTL (Time To Live).
Client API Response
- Write
Create Response
Create a response for a survey and it's fields with the user's responses. The userId & meta here is optional. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Write
Create Response
Create a response for a survey and its fields with the user's responses. The userId & meta here is optional. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Destructive
Update Response
Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Destructive
Update Response
Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
Client API User
- Write
Create or Identify User
Endpoint for creating or identifying a user within the specified workspace. If the user already exists, this will identify them and potentially update user attributes. If they don't exist, it will create a new user. Note - Environments are deprecated.
- Write
Create or Identify User
Endpoint for creating or identifying a user within the specified Workspace. If the user already exists, this will identify them and potentially update user attributes. If they don't exist, it will create a new user. Note - Environments are deprecated.
Management API Action Class
- Read
Get All Action Classes
Fetches all the action classes available in the workspace
- Read
Get Action Class by ID
Fetch an Action Class by it's ID
- Write
Create Action Class
Create Action Class from the UI or from the API! You can read more about them here.
- Destructive
Delete Action Class
Deletes an existing action class
Management API Contact Attribute Keys
- Read
Get All Contact Attribute Keys
Retrieve a list of all contact attribute keys defined in the current workspace
- Read
Get Contact Attribute Key by ID
Retrieve a specific contact attribute key by its ID. This returns detailed information about how a particular attribute is defined in your workspace.
- Read
Get contact attribute keys
Gets contact attribute keys from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Read
Get a contact attribute key
Gets a contact attribute key from the database.
- Write
Create a contact attribute key
Creates a contact attribute key in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Destructive
Update a contact attribute key
Updates a contact attribute key in the database.
- Destructive
Delete a contact attribute key
Deletes a contact attribute key from the database.
Management API Contact Attributes
- Read
Get All Contact Attributes
Retrieve a list of all contact attributes in the current workspace
Management API Contacts
- Read
Get All Contacts
Retrieve a list of all contacts for the current workspace
- Read
Get Contact by ID
Retrieve a specific contact by its ID
- Write
Create a contact
Creates a single contact in the database. This endpoint expects a top-level attributes object. For bulk uploads, use PUT /management/contacts/bulk, which expects contacts[].attributes[] instead. Each contact must have a valid email address in the attributes.
- Destructive
Upload Bulk Contacts
Uploads contacts in bulk. This endpoint expects the bulk request shape: contacts must be an array, and each contact item must contain an attributes array of { attributeKey, value } objects.
Management API Me
- Read
Me
Fetches the product associated with the passed API key
Management API Response
- Read
Get Survey Responses
Pass the surveyId as a Query Parameter & only fetch responses for a specific survey that you have access to.
- Read
Get Response by ID
Fetch the entire response object based on its ID
- Write
Create Response
Create a user response using the management API. This will trigger the response pipeline, including webhooks, integrations, follow-up emails, and other configured actions.
- Destructive
Update Response
Update an existing user response with new data. This will trigger the response pipeline, including webhooks, integrations, follow-up emails (if the response is marked as finished), and other configured actions.
- Destructive
Delete Response
Delete a response with its ID
Management API Storage
- Write
Upload Public File
API endpoint for uploading public files. Uploaded files are public and accessible by anyone. This endpoint requires authentication and enforces a hard limit of 5 MB for all uploads.
Management API Survey
- Read
Get All Surveys
Fetches all existing surveys. Each survey includes both questions (the legacy structure) and blocks (the newer structure). questions is always derived from blocks for backwards compatibility, so integrations may read either field.
- Read
Get Survey by ID
Fetch a survey object based on its ID. The response includes both questions (the legacy structure) and blocks (the newer structure). questions is always derived from blocks for backwards compatibility, so integrations may read either field.
- Read
Get SingleUse Links
Generates multiple single use survey links for a survey based on its id.
- Write
Create Survey
Create a survey with granular settings, questions, their types, welcomeCard, thankYouCard, languages, etc right from this API. We'd however recommend you to do this via our Formbricks App with the UI for a better visual experience.
- Destructive
Update Survey
Update an existing survey with new properties. This is also what we'd recommend you to do from the UI for a better visual feedback.
- Destructive
Delete Survey
Delete a Survey by its ID. Please use this only when extrememly necessary.
Management API Webhook
- Read
Get All Webhooks
Retrieve a list of all webhooks for the current workspace
- Read
Get Webhook
Get a specific webhook object based on its ID
- Write
Create Webhook
Create a new webhook right from the API and see it active right away!
- Destructive
Delete Webhook
Delete an existing webhook by provifding it's ID. It will immediately apply and not trigger again.
Health
- Read
Health Check
Formbricks' Health Check endpoint to make sure the App & the Database are connected with each other & up!
- Read
Health Check
Check the health status of critical application dependencies including database and cache.
Client API Workspace
- Read
Get Workspace State
Retrieves the Workspace state to be used in Formbricks SDKs. Note - Environments are deprecated. Use Workspace/workspaceId terminology. Cache Behavior: This endpoint uses server-side caching with a 5-minute TTL (Time To Live).
Client API File Upload
- Write
Upload Private File
API endpoint for uploading private files. Uploaded files are kept private so that only users with access to the specified Workspace can retrieve them.
Roles
- Read
Get roles
Gets roles from the database.
Me
- Read
Me
Fetches the Workspaces and organizations associated with the API key.
Management API Responses
- Read
Get responses
Gets responses from the database.
- Read
Get a response
Gets a response from the database.
- Write
Create a response
Creates a response in the database. This will trigger the response pipeline, including webhooks, integrations, follow-up emails, and other configured actions.
- Destructive
Update a response
Updates a response in the database. This will trigger the response pipeline, including webhooks, integrations, follow-up emails (if the response is marked as finished), and other configured actions.
- Destructive
Delete a response
Deletes a response from the database.
Management API Surveys Contact Links
- Read
Get personalized survey link for a contact
Retrieves a personalized link for a specific survey.
- Read
Get survey links for contacts in a segment
Generates personalized survey links for contacts in a segment.
Management API Webhooks
- Read
Get webhooks
Gets webhooks from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Read
Get a webhook
Gets a webhook from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Write
Create a webhook
Creates a webhook in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Destructive
Update a webhook
Updates a webhook in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
- Destructive
Delete a webhook
Deletes a webhook from the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
Organizations API Teams
- Read
Get teams
Gets teams from the database.
- Read
Get a team
Gets a team from the database.
- Write
Create a team
Creates a team in the database.
- Destructive
Update a team
Updates a team in the database.
- Destructive
Delete a team
Deletes a team from the database.
Organizations API Workspace Teams
- Read
Get Workspace teams
Gets workspace teams from the database.
- Write
Create a Workspace team
Creates a Workspace team in the database.
- Destructive
Update a Workspace team
Updates a Workspace team in the database.
- Destructive
Delete a Workspace team
Deletes a Workspace team from the database.
Organizations API Users
- Read
Get users
Gets users from the database. Only available for self-hosted Formbricks.
- Write
Create a user
Create a new user in the database. Only available for self-hosted Formbricks.
- Write
Update a user
Updates an existing user in the database. Only available for self-hosted Formbricks. name and isActive apply to the whole account, so they can only be changed for a user who belongs to this organization alone.
V3 Surveys
- Read
List surveys
Returns the surveys in the workspace that the caller may read. A restricted survey is listed only to its owner and to the organisation's owners and managers; to everyone else, API keys included, it does not exist here.
- Read
Validate a survey document
Validates a future create or patch survey payload without writing data, creating languages, or creating survey versions. Invalid survey documents return 200 with data.valid=false so agents and MCP clients can repair payloads from structured invalidparams.
- Read
Retrieve a survey
Returns the public v3 survey management resource for one survey. By default, translatable fields are returned as stable multilingual maps keyed by the language codes emitted in languages[].code. Use lang to filter those maps to one or more requested language selectors.
- Read
Read a survey's visibility and the impact of changing it
Returns the survey's enforced visibility, its owner, the caller's access, and what a change would do: blockers[] lists the outbound connections that currently make restricted refusable (webhooks, integrations, active feedback sources, and draft or enabled workflows), impact carr…
- Write
Create a survey
Creates a block-based survey template from one strict survey document. The endpoint accepts multilingual authoring maps keyed by real locale codes and converts them to Formbricks' internal default-language representation.
- Write
Create a survey draft payload with AI
Creates a strict v3 POST /api/v3/surveys create payload from a creator prompt and returns validation metadata. This endpoint is single-purpose: it does not persist the survey.
- Write
Update a survey
Updates a survey through a strict top-level partial document. Omitted top-level fields are preserved. Provided top-level objects and arrays replace that whole subtree; this endpoint does not deep-merge nested objects and does not implement JSON Patch.
- Write
Edit survey blocks
Edits a survey's blocks in place — update, insert or remove whole blocks without resending the ones you are not changing. Operations apply in order against a single snapshot and are applied atomically: either all of them land or none do.
- Write
Restore a survey
Restores a previously archived (soft-deleted) survey by id, clearing its archive marker so it reappears in the default list and becomes editable again.
- Write
Change a survey's visibility
Sets the survey to restricted or workspace. Restrictions take effect at once. A workspace → restricted request stores the flag, a new version and a pending marker in one transaction.
- Destructive
Delete a survey
Deletes a survey by id. Session cookie, x-api-key, or a Bearer token.
- Destructive
Set survey block order
Replaces the order of a survey's blocks. The body lists every current block id exactly once, in the order you want; block content is untouched.
- Destructive
Archive a survey
Archives (soft-deletes) a survey by id. Archived surveys are hidden from the default list, stop collecting responses, and become read-only until restored — a subsequent PATCH returns 422.
V3 Responses
- Read
List responses
Returns responses for a workspace, newest first. Session cookie, x-api-key, or a Bearer token, with read access. Scoping. workspaceId is required, as on every v3 collection read.
- Read
Count responses
Returns how many responses match a scope and filter set, without fetching any of them.
- Read
Validate a response payload
Checks a create or patch payload and reports what a real write would do — without writing anything. Never has side effects: no response is created, no pipeline fires, nothing is metered.
- Read
Get a response
Returns one response in the detailed view — everything the list view carries, plus contact, displayId, singleUseId, and the stored answer map data.
- Write
Create a response
Records a survey response. Requires read-write access to the workspace, which is resolved from surveyId rather than supplied by the caller. This performs a real submission.
- Write
Update a response
Partially updates a response. Requires read-write access; the workspace is resolved from the response. An unknown or inaccessible responseId answers 403. PATCH is the only update verb — there is no PUT.
- Destructive
Delete responses in bulk
Deletes up to 100 responses in one transaction. Requires manage access to the workspace. A POST custom method, not a DELETE on the collection.
- Destructive
Delete a response
Permanently deletes a response. Requires manage access; the workspace is resolved from the response, and an unknown or inaccessible responseId answers 403. Deletion cascades to any files uploaded with the response, which are removed from storage after the row is committed.
V3 Workflows
- Read
List workflows
Returns workflow list items for a workspace, sorted by sortBy (default updatedAt, newest first). Workflows are workspace-scoped and exposed through the same v3 session-or-API-key authorization model as surveys.
- Read
List workflow runs
Returns workflow run summaries for a workspace, newest first (createdAt descending). Use workflowId to narrow the list to one workflow, or responseId to find the runs a specific survey response produced.
- Read
Retrieve a workflow run
Returns one workflow run by globally unique run id, including the full debug payload: the captured triggerPayload, the run data (per-step results), the persisted logs trace, and retry metadata (attempt, nextAttemptAt, lastErrorAt).
- Read
Retrieve a workflow
Returns one workflow definition by id. Unknown or inaccessible workflow ids return 403 rather than 404 to avoid leaking cross-workspace resource existence.
- Write
Create a workflow
Creates a draft workflow. The workflow definition is the public source of truth used by the dashboard and external clients, following the document-first pattern established by the v3 Survey API.
- Write
Update a workflow
Updates human-facing workflow metadata and/or the workflow definition. Status changes are handled by lifecycle endpoints (enable, disable, archive, unarchive) so the state machine remains explicit.
- Write
Duplicate a workflow
Creates a new draft workflow by copying an existing workflow's definition, name (or the provided override), and description. The duplicate receives its own id and timestamps and starts with empty run and version history; the source workflow is unchanged.
- Write
Enable a workflow
Moves a workflow from draft or disabled to enabled. Only enabled workflows respond to trigger events.
- Write
Disable a workflow
Moves an enabled workflow to disabled. Disabled workflows keep their configuration but do not respond to trigger events; runs that are already queued or running are not canceled. Calling disable in any other state returns 422 with code invalidworkflowstate.
- Write
Unarchive a workflow
Restores an archived workflow to draft. Unarchiving never re-enables a workflow automatically: re-enable explicitly with POST /api/v3/workflows/{workflowId}/enable, which re-validates the definition (the referenced survey or ending cards may have changed while the workflow was a…
- Write
Dry-run (validate) a workflow
Validates a workflow without running it or causing any side effect.
- Destructive
Delete a workflow
Permanently deletes a workflow by id. Deletion cascades to the workflow's versions, runs, and run logs so no response-derived data is left behind (GDPR requirement).
- Destructive
Archive a workflow
Soft-deletes a workflow by moving it from any non-archived state to archived. Archived workflows stop responding to trigger events immediately, become read-only, and are excluded from list responses unless requested with filter[status][in]=archived.
V3 Action Classes
- Read
List action classes
Returns the action classes (user actions that can trigger an app survey) for a workspace. Use the returned ids as distribution.triggers[].actionClassId when creating or updating app surveys.
V3 Contact Attribute Keys
- Read
List contact attribute keys
Returns the contact attribute keys for a workspace. Use the returned key values as targeting.filters[].root.contactAttributeKey when targeting app surveys; dataType hints which operators apply. Session cookie, x-api-key, or a Bearer token.
V3 Tags
- Read
List tags
Returns a workspace's response tags, each with the number of responses currently carrying it. Session cookie only. Tags are managed from the Formbricks app (Workspace settings → Tags); these endpoints back that screen, so they do not accept x-api-key.
- Write
Rename a tag
Renames a tag. The workspace is resolved from the tag itself, so the caller cannot choose which scope it is authorized against. Requires organization owner/manager, or a workspace team membership with read-write permission.
- Write
Merge a tag into another
Moves every response tagged {tagId} onto newTagId, then deletes {tagId}. Both tags must belong to the same workspace — a cross-workspace merge answers 403, since it would move responses across a tenant boundary. Same authorization as rename. Merging a tag into itself answers 400.
- Destructive
Delete a tag
Deletes a tag and removes it from every response carrying it. Same authorization as rename.
V3 Workspaces
- Read
Read workspace custom CSS
Returns the workspace's shared survey CSS as editable source (light and dark), the one recoverable previous revision, whether the stored CSS is being delivered to respondents (status), and whether this caller may change it (canEdit, planAllowed).
- Write
Save or clear workspace custom CSS
Saves or clears the workspace's shared survey CSS. customCss replaces both fields; null clears all of it.
V3 Feedback Records
- Read
List feedback records
Lists the feedback records of one dataset, newest first, with optional filters and keyset pagination. Served by the API gateway, which authorizes the call against tenantid and forwards it to the feedback store — see the introduction for how the two layers answer.
- Read
Search feedback records semantically
Embeds query and returns the ids of the records in the dataset whose text is closest to it, with cosine similarity scores. Only records with a non-empty valuetext are embedded, so only those can match. The gateway reads tenantid from the JSON body to authorize the call.
- Read
Get a feedback record
Returns one feedback record by id, with its read-only assignment in the active directory taxonomy. The assignment reflects the current visible path in the active run; editing a record does not reclassify it until another run. taxonomy is null if its lookup is unavailable.
- Read
Find similar feedback records
Returns the records in the same dataset whose embedded text is closest to the given record's, with cosine similarity scores. The anchor record itself is excluded. The gateway looks the record up to learn its dataset and authorizes against that.
- Write
Create a feedback record
Stores one feedback record in the dataset named by tenantid in the body. The gateway reads tenantid from the JSON body to authorize the call — a body that is not JSON, or has no tenantid, answers 400 before anything is stored.
- Write
Update a feedback record
Changes the answer, language, userid or metadata of one record. Only the members sent are changed; provenance (tenantid, source, field, submissionid, collectedat) is immutable.
- Destructive
Delete a user's feedback records
Permanently deletes every record in the dataset whose userid matches — the erasure operation for GDPR Article 17 requests. Derived embeddings are removed with the records. Idempotent: repeating the call answers deletedcount: 0.
- Destructive
Delete a feedback record
Permanently deletes one record and its derived embedding. Unrecoverable, so it requires an API key with manage permission on a workspace the record's dataset is assigned to, and the dataset must be assigned to exactly one workspace: on a shared dataset no workspace permission ca…
No operations match.
See How connections work for access and permissions, or browse all integrations.