Formbricks

Tool to check the health status of the Formbricks API. Use when you need to verify that the API is operational and responding to requests.

Untrusted display-only summary

Tool to create a new action class. Use when defining custom action logic in your environment.

Untrusted display-only summary

Creates a new attribute class (custom contact attribute) in Formbricks. Attribute classes define the schema for contact attributes used for segmentation and personalization. Each attribute must have a unique key within the environment. Common examples include 'plan', 'tier', 'company', or custom business-specific attr…

Untrusted display-only summary

Tool to create or identify a user within a specified environment. 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. Use when you need to register or update users in the client API for survey targeting.

Untrusted display-only summary

Creates a new contact in a Formbricks environment. A contact represents a person or entity tracked in Formbricks for survey responses and interactions. The email serves as the unique identifier within an environment - if a contact with the same email already exists, this will update the existing contact. Use this acti…

Untrusted display-only summary

Create a display record to track when a survey is shown to users. Displays are used to measure survey view counts and can optionally be linked to a specific user. Use this after obtaining valid survey and environment IDs to register that a survey was displayed.

Untrusted display-only summary

Tool to create a response for a survey. Use after collecting all survey answers.

Untrusted display-only summary

Tool to create a new survey. Use after defining survey details and questions.

Untrusted display-only summary

Tool to create a new webhook. Use when you need to register an external endpoint to receive form response events.

Untrusted display-only summary

Tool to delete an attribute class. Use when you need to remove an attribute class by its ID after confirming it's no longer needed.

Untrusted display-only summary

Tool to delete a person. Use when you need to remove a person's record from Formbricks after confirming the ID.

Untrusted display-only summary

Tool to delete a survey response by its ID. Use when you need to remove an existing response after confirming its ID.

Untrusted display-only summary

Deletes a survey from Formbricks by its unique identifier. Use this action when you need to permanently remove a survey. The deletion cannot be undone. Before deletion, ensure you have the correct survey ID - you can list surveys first to verify. Returns the deleted survey's data including its ID, name, type, status,…

Untrusted display-only summary

Tool to delete an organization team by its ID. Use when you need to permanently remove a team from an organization. Requires write permissions on the organization. Returns the deleted team's details including ID, name, timestamps, and organization ID.

Untrusted display-only summary

Tool to delete a webhook by ID. Use when you need to remove an existing webhook from Formbricks. Use after confirming the webhook ID.

Untrusted display-only summary

Retrieves environment information for the authenticated API key. Returns details about the environment (development or production) including the associated project and setup completion status. This is useful for understanding which environment and project you're working with.

Untrusted display-only summary

Tool to retrieve all contacts within the organization. Use when you need a complete list of contacts.

Untrusted display-only summary

Tool to get a specific attribute class by ID. Use when you need to retrieve details of a specific attribute class for inspection or validation.

Untrusted display-only summary

Tool to get the current state of a contact including surveys and segment information. Use when you need to retrieve tracking data for a specific user, including their segment memberships, survey displays, and response history. This endpoint uses the v2 client API.

Untrusted display-only summary

Tool to retrieve detailed information about a specific contact attribute key by ID (v2 API). Use when you need to inspect the properties of a contact attribute key such as its type, uniqueness requirement, or associated environment.

Untrusted display-only summary

Tool to retrieve a specific contact by its ID. Use when you need to fetch detailed information about a single contact.

Untrusted display-only summary

Tool to retrieve current authenticated organization's and environment details. Use when you need to fetch organization and environment information for the current API key.

Untrusted display-only summary

Tool to retrieve a person by their internal ID in Formbricks. Use when you need detailed information about a specific person, including all their custom attributes. The person ID can be obtained from the Get All Persons endpoint.

Untrusted display-only summary

Retrieve survey responses with flexible filtering, sorting, and pagination. Use this tool to: - List all responses across surveys or filter by specific surveyId - Filter responses by contactId to see submissions from a specific contact - Apply date range filters (startDate/endDate) with filterDateField - Sort by creat…

Untrusted display-only summary

Tool to retrieve all available roles in the system. Use when you need system roles for access control.

Untrusted display-only summary

Tool to retrieve details of a specific webhook. Use when you need to inspect a webhook's configuration by ID.

Untrusted display-only summary

List all action classes in your Formbricks environment. Action classes define trackable user interactions (like clicks, page views, form submissions) that can trigger surveys or be used in targeting logic. Use this to discover what actions are available for survey triggers and audience segmentation.

Untrusted display-only summary

Tool to list all attribute classes. Use when you need to retrieve existing attribute classes for segmentation or management.

Untrusted display-only summary

Tool to retrieve environment state for Formbricks SDKs. Use when you need to fetch the complete environment configuration including surveys, action classes, and project settings. Note: This endpoint uses server-side caching with a 5-minute TTL, so changes may take up to 5 minutes to reflect.

Untrusted display-only summary

Tool to retrieve contact attribute keys from Formbricks. Use when you need to list all available contact attributes for segmentation, filtering, or contact management. Supports pagination, sorting, and date filtering.

Untrusted display-only summary