Check Health
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.
ActionTry it
Integrate Formbricks
with your AI workspace
Formbricks is an open-source platform for building and managing surveys, enabling organizations to collect and analyze user feedback effectively.
Explore Triggers and Actions
Create Action Class
Tool to create a new action class. Use when defining custom action logic in your environment.
ActionTry it
Create Attribute Class
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 attributes. Use this when you need to define new contact attribute types before tracking user data.
ActionTry it
Create Client User
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.
ActionTry it
Create Contact
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 action when you need to: - Register a new contact for survey distribution - Add contact information before sending surveys - Create or update contact records with custom attributes Prerequisites: - An environment ID (use GET_ME to retrieve available environments) - All attribute keys must exist in the environment (email is always available) - Write permissions on the API key
ActionTry it
Create Display
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.
ActionTry it
Create Survey
Tool to create a new survey. Use after defining survey details and questions.
ActionTry it
Create Survey Response
Tool to create a response for a survey. Use after collecting all survey answers.
ActionTry it
Create Webhook
Tool to create a new webhook. Use when you need to register an external endpoint to receive form response events.
ActionTry it
Delete Attribute Class
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.
ActionTry it
Delete Person
Tool to delete a person. Use when you need to remove a person's record from Formbricks after confirming the ID.
ActionTry it
Delete Survey
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, and timestamps.
ActionTry it
Delete Survey Response
Tool to delete a survey response by its ID. Use when you need to remove an existing response after confirming its ID.
ActionTry it
Delete Team
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.
ActionTry it
Delete Webhook
Tool to delete a webhook by ID. Use when you need to remove an existing webhook from Formbricks. Use after confirming the webhook ID.
ActionTry it
Get Account Info
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.
ActionTry it
Get All Contacts
Tool to retrieve all contacts within the organization. Use when you need a complete list of contacts.
ActionTry it
Get Attribute Class
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.
ActionTry it
Get Client Contacts State
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.
ActionTry it
Get Contact Attribute Key
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.
ActionTry it
Get Contact by ID
Tool to retrieve a specific contact by its ID. Use when you need to fetch detailed information about a single contact.
ActionTry it
Get Me
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.
ActionTry it
Get Person by ID
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.
ActionTry it
Get Responses
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 creation or update time (sortBy: createdAt/updatedAt) - Paginate through large result sets (limit: 1-250, skip for offset) Returns detailed response data including answers, completion status, timestamps, contact attributes, time-to-complete metrics, and pagination metadata.
ActionTry it
Get Roles
Tool to retrieve all available roles in the system. Use when you need system roles for access control.
ActionTry it
Get Webhook
Tool to retrieve details of a specific webhook. Use when you need to inspect a webhook's configuration by ID.
ActionTry it
List Action Classes
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.
ActionTry it
List Attribute Classes
Tool to list all attribute classes. Use when you need to retrieve existing attribute classes for segmentation or management.
ActionTry it
List Client Environment
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.
ActionTry it
List Contact Attribute Keys
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.
ActionTry it
List Health
Tool to check the health status of critical application dependencies including database and cache. Use when you need to verify that Formbricks services are operational.
ActionTry it
List Management Contact Attributes
Tool to retrieve all contact attributes in the environment. Use when you need to view custom data stored for contacts across the organization.
ActionTry it
List Management Me
Tool to retrieve authenticated user's environment and project information. Use when you need to get details about the environment associated with the current API key, including project details and setup status.
ActionTry it
List Management People
Tool to retrieve all people (legacy term for contacts) in the environment. Use when you need a complete list of people with their attributes.
ActionTry it
List Organization Teams
Tool to retrieve all teams in an organization (v2 API). Use when you need to list teams within a specific organization, with support for pagination, sorting, and date-based filtering. Returns team details including ID, name, timestamps, and organization ID.
ActionTry it
List Organizations Project Teams
Tool to list all project-team assignments for an organization (v2 API only). Use when you need to retrieve which teams are assigned to which projects, along with their permission levels. Supports filtering by team, project, date range, and pagination.
ActionTry it
List Surveys
List all surveys in the environment. Use this tool to: - Retrieve all surveys with complete configuration details - Access survey questions, endings, triggers, and styling - View survey status and metadata (created/updated timestamps, creator) - Get display settings, targeting, and language configurations Returns complete survey objects including questions, endings, welcome cards, triggers, display options, styling, and all other configuration settings.
ActionTry it
List Webhooks
List all webhooks configured for the current environment. Returns webhooks with pagination support and optional filtering by survey IDs, date ranges, and sorting. Use this action to retrieve webhook configurations, check which surveys have webhooks enabled, or audit webhook settings.
ActionTry it
Update Contact Attributes
Tool to update a contact's attributes in Formbricks. Use when you need to keep contact information in sync with your app or set custom attributes.
ActionTry it
Update Survey
Updates an existing Formbricks survey with new properties. Only include fields you want to modify - all fields except 'id' are optional. Common use cases: - Change survey status (e.g., from 'draft' to 'inProgress' to make it live) - Update survey name or closed message - Modify display settings (delay, frequency, percentage) - Add/update questions, welcome cards, or ending screens - Configure triggers and targeting Requires: Valid survey ID (get from List Surveys or Create Survey actions)
ActionTry it
Update Survey Response
Tool to update an existing survey response. Use after identifying the response to modify.
ActionTry it
Update Webhook
Tool to update an existing webhook. Use when you need to apply modifications to a webhook's configuration.
ActionTry it
Upload Bulk Contacts
Upload multiple contacts to a Formbricks environment in bulk (up to 250 per request). Each contact must include an 'email' attribute with a valid email address. Additional attributes like firstName, lastName, or custom fields can be included. The API returns status 200 for full success or 207 for partial success with details about skipped contacts. Use this tool when you need to efficiently import multiple contacts at once instead of creating them individually.
ActionTry it
Upload Private File
Tool to obtain S3 presigned upload data for a private survey file. Use after confirming environmentId and surveyId.
ActionTry it
Upload Public File
Retrieves S3 presigned upload URLs and form fields for uploading a public file to Formbricks storage. Returns signed URL and presigned fields needed to upload files directly to S3. Maximum file size: 5MB. Uploaded files are publicly accessible. Requires write permissions on the specified environment.
ActionTry it