Skip to main content
Formdesk logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: FORMDESK
  • Version: 20261101_00

Tools

Slug: FORMDESK_AUTOMATIC_LOGINValidates the Formdesk API bearer token and returns authentication details. This action confirms that your connected Formdesk account credentials are valid by making a test API call to the /forms endpoint. It returns the bearer token information that can be used for subsequent authenticated requests. Important: This does NOT perform username/password login. Formdesk uses API keys (bearer tokens) for authentication, which are obtained from your Formdesk account’s User Management section. The username/password parameters are placeholders for API compatibility and are not used. Use this action to: - Verify that your Formdesk API credentials are valid - Retrieve the bearer token from your connected account - Confirm API connectivity before performing other operations How it works: 1. Uses the bearer token from your connected account metadata 2. Validates the token by calling the Formdesk /forms endpoint 3. Returns token details if validation succeeds

Input Parameters

string
Placeholder field (not used for authentication). The action validates the existing bearer token from metadata.
string
Placeholder field (not used for authentication). The action validates the existing bearer token from metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_CREATE_ENTRYSubmit a new entry to a Formdesk form with the supplied field values. Returns the new entry ID when it can be determined; the action can fail after the submission request succeeds if no ID is available.

Input Parameters

object
required
Dictionary mapping field names to their values. Field names must match the form’s field definitions (use FORMDESK_GET_FORM_FIELDS to retrieve field names for a form). Values should match the expected field types. At least one field is required.
string
required
The unique identifier of the Formdesk form to submit an entry to. Use FORMDESK_GET_FORM_LIST to retrieve available forms and their IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_CREATE_FIELDCreates a new field in a Formdesk form. Use this action to add fields like text inputs, email fields, textareas, checkboxes, date pickers, etc. to an existing form. You must have the form ID from FORMDESK_GET_FORM_LIST or FORMDESK_GET_FORM_DETAILS before creating fields. The field definition should specify at minimum the field name, type, and label. Additional properties like ‘required’, ‘placeholder’, ‘description’, and ‘default’ can be included.

Input Parameters

object
required
Field definition object containing the field properties. Common properties include: ‘name’ (field identifier, string), ‘type’ (field type like ‘text’, ‘email’, ‘number’, ‘date’, ‘textarea’, ‘checkbox’, etc.), ‘label’ (display label, string), ‘required’ (whether field is mandatory, boolean), ‘placeholder’ (placeholder text, string, optional), ‘description’ (help text, string, optional), ‘default’ (default value, optional). The exact structure and available types depend on Formdesk API specifications.
string
required
Unique identifier of the form to add the field to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_CREATE_VISITORTool to add a new visitor to a specific Formdesk form. Use when you need to register a visitor’s metadata before submitting entries.

Input Parameters

string
required
Unique identifier of the form to which the visitor will be added
object
required
Key/value pairs of visitor attributes as defined in your Formdesk form. Common keys: ‘name’, ‘email’, ‘firstName’, ‘lastName’, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_DELETE_ENTRYDeletes a specific entry (form submission/result) from a Formdesk form. This action is idempotent - it will succeed even if the entry doesn’t exist (404), making it safe to call multiple times. Use this when you need to remove a form submission permanently. The entry can be obtained from GET_FORM_ENTRIES or GET_ENTRY_DETAILS actions.

Input Parameters

string
required
Unique identifier of the form containing the entry to delete. Can be numeric or alphanumeric string.
string
required
Unique identifier of the specific entry/result to delete from the form. Can be numeric or alphanumeric string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_DELETE_FIELDDelete a specific field from a Formdesk form. A 404 response is treated as success, so a successful result does not necessarily mean the field was deleted by this request.

Input Parameters

string
required
The unique identifier of the form containing the field to delete.
string
required
The unique identifier of the field to delete from the form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_DELETE_FORMDelete a specific form from Formdesk. This action permanently removes a form from the Formdesk account. Use with caution as this operation is destructive and cannot be undone. If the form ID does not exist, the action returns success=False with an appropriate message rather than raising an error. Returns success=True if the form was deleted, or success=False if the form was not found.

Input Parameters

string
required
The unique identifier of the form to delete. Can be a UUID-format string or numeric ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_DELETE_VISITORDeletes a specific visitor from a Formdesk form. This action is idempotent - it will succeed even if the visitor doesn’t exist (404), making it safe to call multiple times. Use this to remove a visitor from a form’s visitor list. Obtain valid form_id from GET_FORM_LIST and visitor_id from GET_FORM_VISITORS actions.

Input Parameters

string
required
The unique identifier of the form containing the visitor to delete.
string
required
The unique identifier of the visitor to delete from the form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_GET_FIELD_DETAILSRetrieve details of a specific field in a Formdesk form using the form and field IDs. Use this to inspect the field’s properties, such as its name, type, label, and whether it is required.

Input Parameters

string
required
Unique identifier of the form containing the field. Obtain this from Get Form List or Get Form Details actions.
string
required
Unique identifier of the field to retrieve. Obtain this from Get Form Fields action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_GET_FORM_DETAILSRetrieves comprehensive details about a specific Formdesk form by its ID. Returns form metadata including name, description, active status, timestamps, public URL, and configuration settings. Use this when you need to inspect form properties or verify form existence before performing other operations.

Input Parameters

string
required
Unique identifier of the form to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_GET_FORM_FIELDSTool to retrieve all fields of a specific form. Use after obtaining the formId to inspect its field definitions.

Input Parameters

string
required
Unique identifier of the form whose fields are to be retrieved. Obtain this from FORMDESK_GET_FORM_LIST action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_GET_FORM_LISTRetrieve a list of all forms in the Formdesk account. This action returns basic information about each form including its ID and name. Use the form ID with other actions (like Get Form Details, Get Form Fields, Get Form Entries) to access more detailed information about a specific form. No parameters are required - this action lists all forms accessible with the current authentication credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_GET_FORM_VISITORSRetrieves all visitors registered to access a specific Formdesk form. Visitors are users who have been granted access to view or complete a form. This action returns visitor details including their credentials, permissions, and registration information. Use this when you need to list all visitors for a form or check visitor access rights. Note: First use ‘Get Form List’ to obtain valid form IDs if you don’t have one.

Input Parameters

string
required
The unique identifier of the form. Use Get Form List action to retrieve available form IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_GET_VISITOR_DETAILSRetrieve details of a specific visitor in a Formdesk form by form and visitor ID. The response contains the visitor ID, name, email, username and password.

Input Parameters

string
required
The unique numeric ID of the form that contains the visitor. Obtain this from Get Form List or Get Form Visitors actions.
string
required
The unique numeric ID of the visitor whose details you want to retrieve. Obtain this from Get Form Visitors or Create Visitor actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_KVK_HANDELSREGISTER_LOOKUPTool to lookup company details from the Dutch KVK Handelsregister. Use when auto-filling company address fields.

Input Parameters

string
Street name of the company’s address
string
KVK (Chamber of Commerce) number of the company
string
Postal code of the company’s address
string
Official registered company name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_MANAGE_VISITOR_ENTRIESRetrieve form entries (submissions) from a Formdesk form. This action fetches submission data from a form’s results database. You can: - List all entries in a form - Filter entries by visitor ID - Retrieve a specific entry by its ID Use cases: - View all form submissions - Track entries submitted by specific visitors - Retrieve detailed information about a specific submission Note: The form must exist and be accessible with your API credentials.

Input Parameters

string
required
The unique identifier of the form. Form IDs can be obtained using the ‘Get Form List’ action.
string
Optional: The unique identifier of a specific entry to retrieve. When provided, returns only that entry. Entry IDs can be obtained from the list of entries.
string
Optional: Filter entries to show only those submitted by a specific visitor. Visitor IDs can be obtained using the ‘Get Form Visitors’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_MULTIPLE_PAGES_FORMTool to create a multi-page Formdesk form. Use when you need forms split into multiple pages for better user experience.

Input Parameters

object
required
JSON payload representing the multi-page form structure according to Formdesk’s schema

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_UPDATE_FIELDUpdates properties of an existing field in a Formdesk form. This action modifies field configuration such as labels, types, validation rules, required status, placeholder text, help text, and default values. Only the properties specified in the request are updated; other properties remain unchanged (partial update). Use this when you need to: - Change a field’s display label or help text - Modify field validation requirements - Update placeholder or default values - Change field type or options for select/radio fields - Toggle required/optional status Note: Requires valid form_id and field_id from existing Formdesk resources.

Input Parameters

string
required
Unique identifier of the form containing the field
string
required
Unique identifier of the field to update
object
required
Dictionary of field properties to update. Common updatable properties include: ‘label’ (field display label), ‘type’ (field type: text, email, number, etc.), ‘required’ (boolean for whether field is mandatory), ‘placeholder’ (placeholder text), ‘helpText’ (help text shown to users), ‘defaultValue’ (default field value), ‘validation’ (validation rules object), ‘options’ (array of options for select/radio fields). Pass only the properties you want to update - unspecified properties remain unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_UPDATE_FORMUpdates an existing Formdesk form’s name or active status. At least one of these properties must be provided.

Input Parameters

string
New name for the form. If not provided, the current name will be retained.
string
required
Unique identifier of the form to update. Use GET_FORM_LIST to retrieve valid form IDs.
boolean
Whether the form should be active (visible and accepting responses) or inactive. If not provided, the current status will be retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FORMDESK_UPDATE_VISITORUpdate an existing visitor’s attributes in a Formdesk form. A visitor represents a unique person or entity who can submit entries to a form. This action modifies visitor attributes such as name, email, or custom fields. Only the attributes you specify will be updated; other attributes remain unchanged. Prerequisites: You must have both the form_id and visitor_id. Obtain these from: - form_id: Use ‘Get Form List’ action - visitor_id: Use ‘Get Form Visitors’, ‘Create Visitor’, or ‘Get Visitor Details’ actions Use Cases: - Update visitor contact information (email, phone, address) - Correct visitor name or other profile details - Modify custom visitor attributes defined in your form - Keep visitor records synchronized with external systems

Input Parameters

string
required
The unique numeric ID of the form that contains the visitor. Obtain this from Get Form List or Get Form Visitors actions.
object
required
Dictionary of visitor attributes to update. Only include fields you want to change. Common attributes: ‘firstName’, ‘lastName’, ‘email’, ‘name’, plus any custom fields defined in your form. Field names must match the field identifiers in your Formdesk form configuration.
string
required
The unique numeric ID of the visitor to update. Obtain this from Get Form Visitors, Create Visitor, or Get Visitor Details actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not