Jotform
Overview
Section titled “Overview”JotForm is an online form builder that allows users to create and manage forms for various purposes, including data collection, surveys, and more. With the JotForm integration in SquadOS, your agents can clone forms, organize labels, query user submissions, and update account settings directly within automations.
- Official website: https://www.jotform.com/
- Composio documentation: docs.composio.dev/toolkits/jotform
Authentication
Section titled “Authentication”This tool uses an API key (API_KEY) to connect.
You will need the following fields:
| Field | Required | Description |
|---|---|---|
api_key | Yes | Your JotForm account API key, used to authenticate all requests. |
How to get credentials
Section titled “How to get credentials”- Go to jotform.com/myaccount/api (log in if needed).
- On the right side of the page, click Create New Key.
- Select the newly created key and enter a descriptive label to identify it.
- Under the Permissions column, click the dropdown arrow and choose your access level: Full Access for read and write operations, or Read Access for read-only.
- Copy the generated key value — this is the value to use in the
api_keyfield when connecting in SquadOS.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
Jotform. - Click the card to open the details and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
- Once done, you’re sent back to SquadOS with the account connected and the tool available to agents. (Connection-flow details in Organization Tools.)
Available actions
Section titled “Available actions”Clone Form
Section titled “Clone Form”JOTFORM_CLONE_FORM
Tool to clone a single form in Jotform. Creates a complete copy of the form with all its questions and settings. Use when you need to duplicate an existing form.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Form ID to clone. This is the unique identifier of the form you want to duplicate. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Create Label
Section titled “Create Label”JOTFORM_CREATE_LABEL
Tool to create a new label for organizing forms in Jotform. Use when you need to categorize or group forms with a named label.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the label to create. This is a required field. |
color | string | No | Color code for the label in hexadecimal format (e.g., #F09E39, #FF5733). If not provided, a default color will be assigned by the system. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Delete Label
Section titled “Delete Label”JOTFORM_DELETE_LABEL
Tool to delete a label along with all its sublabels. Use when you need to remove a label from the account.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Label ID to delete. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get Label
Section titled “Get Label”JOTFORM_GET_LABEL
Tool to retrieve details of a label by its ID, including name and color. Use when you need to fetch information about a specific label.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Label ID to retrieve details for. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get Label Resources
Section titled “Get Label Resources”JOTFORM_GET_LABEL_RESOURCES
Tool to get a list of assets (forms) in a label and their associated information. Use when you need to retrieve forms organized under a specific label.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Label ID to retrieve resources for. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get System Plan
Section titled “Get System Plan”JOTFORM_GET_SYSTEM_PLAN
Tool to retrieve details of a specific system plan. Use when you need to check limits and pricing of a plan.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
planName | string ("FREE" | "BRONZE" | "SILVER" | "GOLD" | "PLATINUM") | Yes | Name of the system plan to retrieve. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Details
Section titled “Get User Details”JOTFORM_GET_USER_DETAILS
Tool to retrieve details of the authenticated user, including account and usage info. Use after confirming valid API key.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Folders
Section titled “Get User Folders”JOTFORM_GET_USER_FOLDERS
Tool to retrieve a list of labels (folders replacement) for the authenticated user. Uses the GET /user/labels endpoint per Jotform’s migration from folders to labels.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
owner | string | No | Owner username or workspace/team ID. Conditionally required for some accounts/workspaces. |
add_resources | boolean | No | Include label resources (e.g., forms) in the response when true (addResources=1). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Forms
Section titled “Get User Forms”JOTFORM_GET_USER_FORMS
Tool to retrieve a list of forms created by the authenticated user. Use after setting up API key authentication.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of forms to return. |
folder | string | No | Filter by folder ID. |
offset | integer | No | Offset for pagination. |
search | string | No | Search query. |
orderby | string | No | Order by field. |
sorting | string | No | Sorting direction: ASC or DESC. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User History
Section titled “Get User History”JOTFORM_GET_USER_HISTORY
Tool to fetch user activity history records. Use when auditing or filtering user actions by type or date.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
date | string ("lastWeek" | "lastMonth" | "last3Months" | "last6Months" | "lastYear" | "all") | No | Predefined date range to limit history. |
action | string | No | Filter history by action type (e.g., userCreation, formUpdate, apiKeyCreated, userLogout). |
sortBy | string ("ASC" | "DESC") | No | Sort order of results. |
endDate | string | No | End date (MM/DD/YYYY) to filter history. |
startDate | string | No | Start date (MM/DD/YYYY) to filter history. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Reports
Section titled “Get User Reports”JOTFORM_GET_USER_REPORTS
Tool to retrieve list of report URLs for all forms in the account. Includes Excel, CSV, printable charts, and embeddable HTML tables.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Settings
Section titled “Get User Settings”JOTFORM_GET_USER_SETTINGS
Tool to retrieve the settings of the authenticated user. Use after confirming a valid API key.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Setting By Key
Section titled “Get User Setting By Key”JOTFORM_GET_USER_SETTINGS_BY_KEY
Tool to retrieve a specific user setting by key. Use when you need a single setting value like email, timezone, language, or website.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
settingsKey | string | Yes | The specific user setting key to retrieve. Common keys include: email, timezone, language, website. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Submissions
Section titled “Get User Submissions”JOTFORM_GET_USER_SUBMISSIONS
Tool to retrieve all submissions for all forms on the account. The answers dictionary contains submission data with question IDs as keys. Use when you need to access submission data across multiple forms.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Number of results in each result set for submission data. Default is 20. Maximum is 1000. |
filter | string | No | Filters the query results to fetch a specific submissions range. Provide as JSON string, example: '{"new":"1"}' to filter only new submissions. |
offset | integer | No | Start of each result set for submission data. Useful for pagination. Default is 0. |
orderby | string | No | Order results by a submission field name: id, form_id, IP, created_at, status, new, flag, updated_at. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Get User Usage
Section titled “Get User Usage”JOTFORM_GET_USER_USAGE
Tool to retrieve monthly usage statistics for the authenticated user. Use to check form submissions, payment forms, SSL submissions, and storage used.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Remove Resources from Label
Section titled “Remove Resources from Label”JOTFORM_REMOVE_LABEL_RESOURCES
Tool to remove specified resources (forms) from a label by their IDs and types. Use when you need to unassign forms from a specific label.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier of the label from which resources will be removed. |
resources | array | Yes | List of resources (forms) to remove from the label. Each resource must specify an id and type. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Update Label
Section titled “Update Label”JOTFORM_UPDATE_LABEL
Tool to update an existing label with new name or color settings. Use when you need to modify label properties.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Label ID to update. |
name | string | No | New name for the label. |
color | string | No | New color for the label in hex format (e.g., #FF5733). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |
Update User Settings
Section titled “Update User Settings”JOTFORM_UPDATE_USER_SETTINGS
Tool to update user’s settings like time zone, language, email, and website. Use when you need to modify user account settings.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Full name of the user. |
email | string | No | New email address for the user. |
company | string | No | Company name of the user. |
website | string | No | New website URL for the user. |
industry | string | No | Industry sector of the user. |
language | string | No | Preferred language code for the user (e.g., en, es, fr). |
time_zone | string | No | IANA time zone identifier for the user (e.g., America/New_York, Europe/London). |
securityAnswer | string | No | Answer to the security question. |
securityQuestion | string | No | Security question for account recovery. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error message if execution failed. |
successful | boolean | Yes | Whether the action executed successfully. |