- Category: forms & surveys
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 45
- Triggers: 0
- Slug:
FORMBRICKS - Version: 20261101_00
Tools
Check Health
Check Health
Create Action Class
Create Action Class
FORMBRICKS_CREATE_ACTION_CLASSTool to create a new action class. Use when defining custom action logic in your environment.Input Parameters
Output
Create Attribute Class
Create Attribute Class
FORMBRICKS_CREATE_ATTRIBUTE_CLASSCreates 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.Input Parameters
Output
Create Client User
Create Client User
FORMBRICKS_CREATE_CLIENT_USERTool 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.Input Parameters
Output
Create Contact
Create Contact
FORMBRICKS_CREATE_CONTACTCreates 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 keyInput Parameters
Output
Create Display
Create Display
FORMBRICKS_CREATE_DISPLAYCreate 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.Input Parameters
Output
Create Survey Response
Create Survey Response
FORMBRICKS_CREATE_RESPONSETool to create a response for a survey. Use after collecting all survey answers.Input Parameters
Output
Create Survey
Create Survey
Create Webhook
Create Webhook
FORMBRICKS_CREATE_WEBHOOKTool to create a new webhook. Use when you need to register an external endpoint to receive form response events.Input Parameters
Output
Delete Attribute Class
Delete Attribute Class
Delete Person
Delete Person
Delete Survey Response
Delete Survey Response
Delete Survey
Delete Survey
Delete Team
Delete Team
Delete Webhook
Delete Webhook
Get Account Info
Get Account Info
FORMBRICKS_GET_ACCOUNT_INFORetrieves 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.Output
Get All Contacts
Get All Contacts
Get Attribute Class
Get Attribute Class
Get Client Contacts State
Get Client Contacts State
FORMBRICKS_GET_CLIENT_CONTACTS_STATERetrieves the current state of a contact for a specific user, including segment memberships, survey displays, and response history, using the v1 client API.Input Parameters
Output
Get Contact Attribute Key
Get Contact Attribute Key
Get Contact by ID
Get Contact by ID
Get Me
Get Me
Get Person by ID
Get Person by ID
FORMBRICKS_GET_PERSON_BY_IDTool 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.Input Parameters
Output
Get Responses
Get Responses
FORMBRICKS_GET_RESPONSESRetrieve 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.Input Parameters
Output
Get Roles
Get Roles
Get Webhook
Get Webhook
List Action Classes
List Action Classes
FORMBRICKS_LIST_ACTION_CLASSESList 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.Output
List Attribute Classes
List Attribute Classes
List Client Environment
List Client Environment
FORMBRICKS_LIST_CLIENT_ENVIRONMENTTool 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.Input Parameters
Output
List Contact Attribute Keys
List Contact Attribute Keys
List Health
List Health
List Management Contact Attributes
List Management Contact Attributes
List Management Me
List Management Me
List Management People
List Management People
List Organizations Project Teams
List Organizations Project Teams
FORMBRICKS_LIST_ORGANIZATIONS_PROJECT_TEAMSTool 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.Input Parameters
Output
List Organization Teams
List Organization Teams
FORMBRICKS_LIST_ORGANIZATION_TEAMSTool 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.Input Parameters
Output
List Surveys
List Surveys
FORMBRICKS_LIST_SURVEYSList 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.Output
List Webhooks
List Webhooks
FORMBRICKS_LIST_WEBHOOKSList 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.Input Parameters
Output
Update Contact Attributes
Update Contact Attributes
FORMBRICKS_UPDATE_CONTACT_ATTRIBUTESTool 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.Input Parameters
Output
Update Survey Response
Update Survey Response
Update Survey
Update Survey
FORMBRICKS_UPDATE_SURVEYUpdates an existing Formbricks survey by ID, including its status, name, display settings, questions, welcome card, endings, and triggers. Only supplied optional fields are sent.Input Parameters
Output
Update Webhook
Update Webhook
FORMBRICKS_UPDATE_WEBHOOKUpdates an existing webhook’s configuration by ID. The request requires the webhook’s name, URL, source, environment, triggers, and survey IDs; the name may be null.Input Parameters
Output
Upload Bulk Contacts
Upload Bulk Contacts
FORMBRICKS_UPLOAD_BULK_CONTACTSUpload 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.Input Parameters
Output
Upload Private File
Upload Private File
Upload Public File
Upload Public File
FORMBRICKS_UPLOAD_PUBLIC_FILERetrieves 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.