Jotform

Jotform is an online form builder used to collect responses through forms, surveys, applications, and registrations.

With the Jotform integration in Sim, you can:

  • Read submissions: Pull responses from one form or across every form on the account, filtered by date, read/unread state, or full-text search
  • Work with answers directly: Every submission comes back keyed by question ID and re-keyed by question label, so a response is usable without a second lookup
  • Manage forms: List, read, create, clone, and delete forms, and edit their settings — redirect behavior, submission limits, layout, and notification emails
  • Edit questions: List, add, update, and delete form fields individually or in bulk, including validation and field-specific properties
  • Create submissions: Submit entries through the API, one at a time or in batches, and edit or delete existing responses
  • Build reports: Create shareable Excel, CSV, grid, table, calendar, RSS, or visual reports scoped to the fields you choose
  • Register webhooks: Push new submissions to a URL the moment they arrive, and list or remove existing webhooks
  • Organize with labels: Group forms, workflows, sheets, and apps into labels, and assign or unassign assets in bulk
  • Retrieve uploads: List every file submitted through a form with its download URL, size, and originating submission
  • Check the account: Read plan details, monthly usage counters, sub-user access grants, settings, and the activity log

In Sim, the Jotform integration lets your agents treat form responses as workflow input. Typical patterns include routing new submissions to the right team, enriching them with an agent before they reach a CRM or ticketing system, syncing responses into tables for reporting, and pushing submissions downstream in real time through webhooks.

Authentication and regions

The integration authenticates with a Jotform API key, created under Account Settings → API. Keys are scoped to read-only or full access, so create the key at the level your operations need — creating submissions, editing forms, and managing webhooks all require full access.

An API key is only valid on the host that issued it. Use the Region field to match where the account lives: us (default), eu for EU data residency accounts, or hipaa for HIPAA-compliant accounts. A key used against the wrong host returns an authentication error.

Jotform enforces a daily API call limit that varies by plan. Schedule high-frequency polling with that budget in mind — or prefer a webhook, which costs no API calls at all.

A note on question IDs

Submissions are keyed by question ID, not by label. Run List Questions on a form first to map each label to its qid; those IDs are what Create Submission and Update Submission expect. Multi-field questions such as full name or address accept either a nested object ({"3": {"first": "Bart", "last": "Simpson"}}) or the shorthand Jotform documents ({"3_first": "Bart"}).

Folders and labels

Jotform has deprecated its folder endpoints in favor of labels. This integration implements labels only; if you have existing automations built on folder IDs, migrate them to the label operations.

Usage Instructions

Integrate Jotform into your workflow to list and read form submissions with their answers resolved to question labels, build and edit forms and their questions, create shareable reports, register submission webhooks, and check account usage.

Actions

Jotform List Forms

List the forms on a Jotform account with their titles, status, and submission counts.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
offsetstringNoIndex of the first result to return. Default 0
limitstringNoNumber of forms to return. Default 20, maximum 1000
orderbystringNoField to order by: id, username, title, status, created_at, updated_at, new, count, or slug
directionstringNoSort direction: ASC or DESC
filterjsonNoFilter object, e.g. {"status":"ENABLED"} or {"created_at:gt":"2024-01-01 00:00:00"}

Output

ParameterTypeDescription
formsarrayForms on the account
idstringForm ID
usernamestringAccount that owns the form
titlestringForm title
heightstringForm height in pixels
statusstringENABLED, DISABLED, or DELETED
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
last_submissionstringTime of the most recent submission
newstringUnread submission count
countstringTotal submission count
typestringLEGACY or CARD
favoritestring1 when the form is favorited, otherwise 0
archivedstring1 when the form is archived, otherwise 0
urlstringPublic form URL
paginationobjectResult window reported by the API
offsetnumberIndex of the first returned form
limitnumberPage size applied
countnumberNumber of forms returned

Jotform Get Form

Get the details of a single Jotform form, including its status, URL, and submission counts.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesForm ID, the numeric segment of the form URL

Output

ParameterTypeDescription
formobjectThe requested form
idstringForm ID
usernamestringAccount that owns the form
titlestringForm title
heightstringForm height in pixels
statusstringENABLED, DISABLED, or DELETED
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
last_submissionstringTime of the most recent submission
newstringUnread submission count
countstringTotal submission count
typestringLEGACY or CARD
favoritestring1 when the form is favorited, otherwise 0
archivedstring1 when the form is archived, otherwise 0
urlstringPublic form URL

Jotform Create Form

Create a new Jotform form from a list of questions, plus optional form properties and notification emails.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
questionsjsonYesArray of question objects, each with type, text, order, and name, e.g. [{"type":"control_email","text":"Email","order":"1","name":"email"}]
propertiesjsonNoForm properties object, e.g. {"title":"Contact Us","height":"600"}
emailsjsonNoArray of email objects, each with type (notification or autorespond), from, to, subject, html, and body

Output

ParameterTypeDescription
formobjectThe created form
idstringID of the created form
usernamestringAccount that owns the form
titlestringForm title
heightstringForm height in pixels
statusstringENABLED, DISABLED, or DELETED
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
newstringUnread submission count
countstringTotal submission count
urlstringPublic form URL

Jotform Clone Form

Clone an existing Jotform form and return the copy.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to clone

Output

ParameterTypeDescription
formobjectThe newly created copy
idstringID of the cloned form
usernamestringAccount that owns the clone
titlestringForm title
heightstringForm height in pixels
statusstringENABLED, DISABLED, or DELETED
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
last_submissionstringTime of the most recent submission
newstringUnread submission count
countstringTotal submission count
typestringLEGACY or CARD
favoritestring1 when the form is favorited, otherwise 0
archivedstring1 when the form is archived, otherwise 0
urlstringPublic URL of the cloned form

Jotform Delete Form

Delete a Jotform form. The API returns the form with status DELETED.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to delete

Output

ParameterTypeDescription
formobjectThe deleted form, as the API reports it after deletion
idstringForm ID
usernamestringAccount that owned the form
titlestringForm title
heightstringForm height in pixels
statusstringDELETED after a successful delete
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringDeletion time, YYYY-MM-DD HH:MM:SS
newstringUnread submission count
countstringTotal submission count

Jotform Get Form Properties

Get the settings of a form: layout, limits, redirect behavior, notification emails, and validation strings. Supply a property key to read just one.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to read properties from
propertyKeystringNoSingle property to read instead of the whole set, e.g. formWidth, thankurl, or activeRedirect

Output

ParameterTypeDescription
propertiesjsonForm properties keyed by property name. The set varies by form; documented keys include formWidth, labelWidth, activeRedirect, thankurl, expireDate, limitSubmission, styles, emails, and formStrings.

Jotform Update Form Properties

Update form settings such as the thank-you redirect, submission limit, width, or styles. Only the supplied keys change.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to update
propertiesjsonYesProperties to set, e.g. {"thankurl":"https://example.com/thanks","activeRedirect":"thankurl","formWidth":"650"\}

Output

ParameterTypeDescription
propertiesjsonThe property keys that were edited, with their new values

Jotform List Form Files

List every file uploaded through a form, with its download URL, size, type, and the submission it came from.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form whose uploads to list

Output

ParameterTypeDescription
filesarrayFiles uploaded through the form
namestringFile name
typestringMIME type, e.g. image/png
sizestringFile size in bytes
usernamestringAccount that owns the form
form_idstringForm the file was uploaded through
submission_idstringSubmission the file belongs to
datestringUpload time, YYYY-MM-DD HH:MM:SS
urlstringDownload URL for the file

Jotform List Questions

List every question on a form with its question ID, label, and field type. Question IDs are what submissions are keyed by.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form whose questions to list

Output

ParameterTypeDescription
questionsarrayQuestions on the form. Each entry also carries the type-specific properties Jotform stores for that field, such as validation, sublabels, or options.
qidstringQuestion ID, used to key submission answers
namestringSlug of the question label
orderstringPosition of the question on the form
textstringQuestion label
typestringField type, e.g. control_textbox, control_textarea, control_dropdown, control_fullname, control_email, control_fileupload
requiredstringYes when the question is required

Jotform Get Question

Get every property of a single form question, including its validation rules and field-specific settings.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form the question belongs to
questionIdstringYesQuestion ID, available from the List Questions operation

Output

ParameterTypeDescription
questionobjectThe requested question. Also carries the type-specific properties Jotform stores for that field.
qidstringQuestion ID
namestringSlug of the question label
orderstringPosition of the question on the form
textstringQuestion label
typestringField type, e.g. control_head or control_textbox
requiredstringYes when the question is required

Jotform Create Question

Add a question to an existing Jotform form.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to add the question to
questionTypestringYesField type, e.g. control_textbox, control_textarea, control_dropdown, control_radio, control_checkbox, control_fileupload, control_fullname, control_email, or control_datetime
textstringNoQuestion label shown on the form
orderstringNoPosition of the question on the form
namestringNoSlug for the question label
questionPropertiesjsonNoAdditional type-specific properties merged into the question, e.g. {"required":"Yes","validation":"Numeric"}

Output

ParameterTypeDescription
questionobjectThe created question, as stored on the form
qidstringID assigned to the new question
namestringSlug of the question label
orderstringPosition of the question on the form
textstringQuestion label
typestringField type of the question
requiredstringYes when the question is required

Jotform Update Question

Edit the properties of a form question, such as its label, order, or validation. Only the supplied properties change.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form the question belongs to
questionIdstringYesID of the question to edit
textstringNoNew question label
orderstringNoNew position of the question on the form
namestringNoNew slug for the question label
questionPropertiesjsonNoAdditional type-specific properties to set, e.g. {"required":"Yes","validation":"Email"}

Output

ParameterTypeDescription
questionjsonThe question properties that were edited, with their new values. Jotform echoes only the changed keys, such as text, order, and type.

Jotform Delete Question

Delete a question from a Jotform form.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form the question belongs to
questionIdstringYesID of the question to delete

Output

ParameterTypeDescription
deletedbooleanTrue when Jotform accepted the deletion
messagestringConfirmation text returned by Jotform

Jotform List Form Submissions

List the submissions received by one form, with each answer available both by question ID and by question label.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form whose submissions to list
offsetstringNoIndex of the first result to return. Default 0
limitstringNoNumber of submissions to return. Default 20, maximum 1000
orderbystringNoField to order by: id, form_id, IP, created_at, status, new, flag, or updated_at
directionstringNoSort direction: ASC or DESC
filterjsonNoFilter object, e.g. {"created_at:gt":"2024-01-01 00:00:00"}, {"new":"1"}, or {"fullText":"John Brown"}

Output

ParameterTypeDescription
submissionsarraySubmissions received by the form
idstringSubmission ID
form_idstringForm the submission belongs to
ipstringIP address of the submitter
created_atstringSubmission time, YYYY-MM-DD HH:MM:SS
updated_atstringLast edit time, YYYY-MM-DD HH:MM:SS
statusstringACTIVE or OVERQUOTA
newstring1 when the submission is unread
workflowStatusstringApproval state, present only when the form feeds a workflow
answersjsonAnswers keyed by question ID. Each holds text (the question label), type, answer, and prettyFormat when Jotform renders one.
valuesjsonThe same answers re-keyed by question label, each rendered as a single string. A label shared by more than one question is suffixed with its question ID on every occurrence, so no answer is lost.
paginationobjectResult window reported by the API
offsetnumberIndex of the first returned submission
limitnumberPage size applied
countnumberNumber of submissions returned

Jotform List Submissions

List submissions across every form on the account, optionally narrowed to specific forms or a date range.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
offsetstringNoIndex of the first result to return. Default 0
limitstringNoNumber of submissions to return. Default 20, maximum 1000
orderbystringNoField to order by: id, form_id, IP, created_at, status, new, flag, or updated_at
directionstringNoSort direction: ASC or DESC
filterjsonNoFilter object, e.g. {"formIDs":["231234567890"]}, {"created_at:gt":"2024-01-01 00:00:00"}, or {"fullText":"John Brown"}

Output

ParameterTypeDescription
submissionsarraySubmissions across every form on the account
idstringSubmission ID
form_idstringForm the submission belongs to
ipstringIP address of the submitter
created_atstringSubmission time, YYYY-MM-DD HH:MM:SS
updated_atstringLast edit time, YYYY-MM-DD HH:MM:SS
statusstringACTIVE or OVERQUOTA
newstring1 when the submission is unread
workflowStatusstringApproval state, present only when the form feeds a workflow
answersjsonAnswers keyed by question ID. Each holds text (the question label), type, answer, and prettyFormat when Jotform renders one.
valuesjsonThe same answers re-keyed by question label, each rendered as a single string. A label shared by more than one question is suffixed with its question ID on every occurrence, so no answer is lost.
paginationobjectResult window reported by the API
offsetnumberIndex of the first returned submission
limitnumberPage size applied
countnumberNumber of submissions returned

Jotform Get Submission

Get a single Jotform submission, with its answers available both by question ID and by question label.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
submissionIdstringYesID of the submission to read

Output

ParameterTypeDescription
submissionobjectThe requested submission
idstringSubmission ID
form_idstringForm the submission belongs to
ipstringIP address of the submitter
created_atstringSubmission time, YYYY-MM-DD HH:MM:SS
updated_atstringLast edit time, YYYY-MM-DD HH:MM:SS
statusstringACTIVE or OVERQUOTA
newstring1 when the submission is unread
workflowStatusstringApproval state, present only when the form feeds a workflow
answersjsonAnswers keyed by question ID. Each holds text (the question label), type, answer, and prettyFormat when Jotform renders one.
valuesjsonThe same answers re-keyed by question label, each rendered as a single string. A label shared by more than one question is suffixed with its question ID on every occurrence, so no answer is lost.

Jotform Create Submission

Submit an entry to a Jotform form. Answers are keyed by question ID, which the List Questions operation returns.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to submit to
answersjsonYesAnswers keyed by question ID. Multi-field questions take either a nested object or the documented shorthand, e.g. {"3":{"first":"Bart","last":"Simpson"},"4":"Hello"} or {"3_first":"Bart","3_last":"Simpson"}

Output

ParameterTypeDescription
submissionIdstringID of the submission that was created
urlstringAPI URL of the new submission

Jotform Update Submission

Edit an existing Jotform submission. Only the question IDs supplied are changed; the rest keep their stored answers.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
submissionIdstringYesID of the submission to edit
answersjsonYesAnswers to overwrite, keyed by question ID, e.g. {"4":"Updated message","3":{"first":"Lisa"}} or the shorthand {"3_first":"Lisa"}. The control keys new, flag, and status are passed through unchanged.

Output

ParameterTypeDescription
submissionIdstringID of the submission that was edited
urlstringAPI URL of the submission

Jotform Delete Submission

Delete a single Jotform submission.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
submissionIdstringYesID of the submission to delete

Output

ParameterTypeDescription
deletedbooleanTrue when Jotform accepted the deletion
messagestringConfirmation text returned by Jotform

Jotform List Reports

List every report on the account, across all forms, with the shareable URL for each Excel, CSV, grid, table, calendar, RSS, or visual report.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"

Output

ParameterTypeDescription
reportsarrayReports across every form on the account
idstringReport ID
form_idstringForm the report is built from
titlestringReport title
fieldsstringComma-separated fields included in the report: ip, dt (submission date), and question IDs
list_typestringReport type: excel, csv, grid, table, calendar, rss, or visual
statusstringENABLED or DELETED
urlstringShareable URL of the report
isProtectedbooleanTrue when the report is password protected
settingsstringReport display settings, as a JSON string
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS

Jotform List Form Reports

List the reports built from one form, each with its shareable URL.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form whose reports to list

Output

ParameterTypeDescription
reportsarrayReports built from the form
idstringReport ID
form_idstringForm the report is built from
titlestringReport title
fieldsstringComma-separated fields included in the report: ip, dt (submission date), and question IDs
list_typestringReport type: excel, csv, grid, table, calendar, rss, or visual
statusstringENABLED or DELETED
urlstringShareable URL of the report
isProtectedbooleanTrue when the report is password protected
settingsstringReport display settings, as a JSON string
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS

Jotform Create Report

Create a shareable report of a form, choosing the report type and which submission fields it shows.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to build the report from
titlestringYesTitle of the report
listTypestringYesReport type: excel, csv, grid, table, calendar, rss, or visual
fieldsstringNoComma-separated fields to include: ip, dt (submission date), and question IDs, e.g. "ip,dt,3,4"

Output

ParameterTypeDescription
reportobjectThe created report
idstringReport ID
form_idstringForm the report is built from
titlestringReport title
fieldsstringComma-separated fields included in the report
list_typestringReport type that was created
statusstringENABLED or DELETED
urlstringShareable URL of the report
isProtectedbooleanTrue when the report is password protected

Jotform Get Report

Get the details and shareable URL of a single Jotform report.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
reportIdstringYesID of the report to read

Output

ParameterTypeDescription
reportobjectThe requested report
idstringReport ID
form_idstringForm the report is built from
titlestringReport title
fieldsstringComma-separated fields included in the report
list_typestringReport type: excel, csv, grid, table, calendar, rss, or visual
statusstringENABLED or DELETED
urlstringShareable URL of the report
isProtectedbooleanTrue when the report is password protected
settingsstringReport display settings, as a JSON string
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS

Jotform Delete Report

Delete an existing Jotform report.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
reportIdstringYesID of the report to delete

Output

ParameterTypeDescription
deletedbooleanTrue when Jotform accepted the deletion
messagestringConfirmation text returned by Jotform

Jotform List Webhooks

List the webhooks registered on a form. The returned IDs are what the Delete Webhook operation takes.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form whose webhooks to list

Output

ParameterTypeDescription
webhooksarrayWebhooks registered on the form
idstringWebhook ID, used when deleting the webhook
urlstringURL that receives submission notifications

Jotform Create Webhook

Register a webhook on a form so every new submission is posted to the given URL. Returns the full webhook list for the form.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to add the webhook to
webhookUrlstringYesURL that Jotform posts submission data to

Output

ParameterTypeDescription
webhooksarrayWebhooks registered on the form after the addition
idstringWebhook ID, used when deleting the webhook
urlstringURL that receives submission notifications

Jotform Delete Webhook

Remove a webhook from a form. Returns the webhooks that remain registered on the form.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form the webhook belongs to
webhookIdstringYesWebhook ID, available from the List Webhooks operation

Output

ParameterTypeDescription
webhooksarrayWebhooks still registered on the form after the deletion
idstringWebhook ID
urlstringURL that receives submission notifications

Jotform Get Account

Get the Jotform account behind the API key, including its plan, status, time zone, and contact details.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"

Output

ParameterTypeDescription
userobjectThe account the API key belongs to
usernamestringJotform username
namestringDisplay name on the account
emailstringAccount email address
websitestringWebsite recorded on the account
time_zonestringAccount time zone, in IANA format
account_typestringURL of the plan the account is on
statusstringACTIVE, DELETED, or SUSPENDED
created_atstringAccount creation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
is_verifiedstring1 when the account email is verified
industrystringIndustry recorded on the account
companystringCompany recorded on the account
languagestringAccount interface language, e.g. en-US
avatarUrlstringAvatar image URL
usagestringURL of the monthly usage endpoint

Jotform Get Usage

Get this month usage for the account: submissions received, payments, form views, upload space, and API calls made today.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"

Output

ParameterTypeDescription
usageobjectUsage counters for the current month
submissionsstringSubmissions received this month
ssl_submissionsstringSecure submissions received this month
paymentsstringPayment submissions received this month
uploadsstringDisk space used by uploaded files, in bytes
mobile_submissionsstringMobile submissions received this month
viewsstringForm views received this month
apistringAPI calls made today

Jotform Get History

Read the account activity log: forms created, updated, deleted or purged, and account logins.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
actionstringNoActivity to filter by: all (default), userCreation, userLogin, formCreation, formUpdate, formDelete, or formPurge
datestringNoNamed date range to limit results to, e.g. lastWeek. Use startDate and endDate for an explicit range instead
sortBystringNoSort order: ASC or DESC
startDatestringNoOnly return activity after this date. Format MM/DD/YYYY
endDatestringNoOnly return activity before this date. Format MM/DD/YYYY

Output

ParameterTypeDescription
historyarrayAccount activity entries
typestringActivity type: userCreation, userLogin, formCreation, formUpdate, formDelete, or formPurge
formIDstringForm the activity applied to
usernamestringAccount that performed the activity
formTitlestringTitle of the affected form
formStatusstringStatus of the form after the activity
ipstringIP address the activity came from
timestampstringUnix timestamp of the activity, in seconds

Jotform Create Submissions

Submit several entries to a Jotform form in one call. Each entry is keyed by question ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to submit to
submissionsjsonYesArray of submissions. Each entry maps a question ID to an object holding its answer, e.g. [{"1":{"text":"Answer 1"},"2":{"text":"Answer 2"}}]

Output

ParameterTypeDescription
submissionsarrayThe submissions that were created
submissionIdstringID of the created submission
urlstringAPI URL of the created submission
countnumberNumber of submissions created

Jotform Create Questions

Add several questions to an existing Jotform form in one call.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
formIdstringYesID of the form to add the questions to
questionsjsonYesArray of question objects, each with type, text, order, and name, e.g. [{"type":"control_head","text":"Text 1","order":"1","name":"Header1"}]

Output

ParameterTypeDescription
questionsarrayThe questions that were added, as stored on the form
qidstringID assigned to the question
namestringSlug of the question label
orderstringPosition of the question on the form
textstringQuestion label
typestringField type of the question
requiredstringYes when the question is required

Jotform List Labels

List the labels on the account as a tree. Labels are how Jotform groups forms, workflows, sheets, and apps, replacing the older folder endpoints.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
addResourcesstringNoSet to "true" to include the resources assigned to each label

Output

ParameterTypeDescription
labelsarrayLabels on the account. The API returns a root entry whose sublabels hold the user-visible labels, nested to arbitrary depth.
idstringLabel ID
namestringLabel name
orderstringPosition among its siblings
colorstringLabel color, as a hex code
ownerstringAccount that owns the label
parent_label_idstringID of the parent label
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
sublabelsjsonNested labels beneath this one

Jotform Get Label

Get the name, color, and owner of a single Jotform label.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
labelIdstringYesID of the label to read, available from the List Labels operation

Output

ParameterTypeDescription
labelobjectThe requested label
idstringLabel ID
namestringLabel name
orderstringPosition among its siblings
colorstringLabel color, as a hex code
ownerstringAccount that owns the label
ownerTypestringOwner kind, e.g. USER
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS

Jotform Create Label

Create a Jotform label for grouping forms and other assets, optionally nested under a parent label.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
labelNamestringYesName of the label, e.g. "IT Operations"
colorstringNoLabel color as a hex code, e.g. "#FFDC7B"
parentstringNoID of the parent label to nest this label under

Output

ParameterTypeDescription
labelobjectThe created label
idstringID assigned to the new label
namestringLabel name
colorstringLabel color, as a hex code
ownerstringAccount that owns the label
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS

Jotform Update Label

Rename a Jotform label or change its color.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
labelIdstringYesID of the label to update
labelNamestringNoNew name for the label
colorstringNoNew label color as a hex code, e.g. "#23FFDD"

Output

ParameterTypeDescription
labeljsonThe label fields that were edited, with their new values. Jotform echoes only the changed keys, such as name and color.

Jotform Delete Label

Delete a Jotform label along with all of its sublabels.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
labelIdstringYesID of the label to delete

Output

ParameterTypeDescription
deletedbooleanTrue when Jotform accepted the deletion
messagestringConfirmation text returned by Jotform

Jotform List Label Resources

List the assets assigned to a label — forms, workflows, sheets, and apps — with their status and titles.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
labelIdstringYesID of the label whose assets to list
offsetstringNoIndex of the first result to return. Default 0
limitstringNoNumber of assets to return
orderbystringNoField to order by, e.g. created_at
statusstringNoFilter by asset status, e.g. active

Output

ParameterTypeDescription
resourcesarrayAssets assigned to the label
idstringAsset ID
usernamestringAccount that owns the asset
titlestringAsset title
statusstringAsset status, e.g. ENABLED or AUTODISABLED
assetTypestringKind of asset: form, workflow, sheet, or portal
typestringAsset subtype, e.g. LEGACY, APP, or default
labelsstringLabel IDs the asset belongs to
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS

Jotform Add Label Resources

Assign forms, workflows, sheets, or apps to a Jotform label.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
labelIdstringYesID of the label to assign the assets to
resourcesjsonYesAssets to add, each with an id and a type of form, workflow, sheet, or portal, e.g. [{"id":"251464995493876","type":"form"}]

Output

ParameterTypeDescription
resourcesarrayThe assets now assigned to the label
idstringAsset ID
typestringAsset kind, echoed uppercase: FORM, WORKFLOW, SHEET, or PORTAL

Jotform Remove Label Resources

Unassign forms, workflows, sheets, or apps from a Jotform label.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
labelIdstringYesID of the label to remove the assets from
resourcesjsonYesAssets to remove, each with an id and a type of form, workflow, sheet, or portal, e.g. [{"id":"251464995493876","type":"form"}]

Output

ParameterTypeDescription
resourcesarrayThe assets reported by the API after the removal
idstringAsset ID
typestringAsset kind, echoed uppercase: FORM, WORKFLOW, SHEET, or PORTAL

Jotform List Sub-Users

List the sub-users on the account with the forms and folders each one can reach, and at what access level.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"

Output

ParameterTypeDescription
subusersarraySub-users on the account
usernamestringSub-user username
emailstringSub-user email address
ownerstringParent account that created the sub-user
statusstringLIVE, DELETED, or PENDING while an invitation is unaccepted
created_atstringCreation time, YYYY-MM-DD HH:MM:SS
permissionsjsonWhat the sub-user can reach: each entry has type (FORM, FOLDER, or ALL), resource_id, access_type (full or readOnly), and title

Jotform Get Settings

Read the account settings behind the API key, including time zone, language, and contact details.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
settingsKeystringNoSingle setting to read instead of the whole set, e.g. time_zone

Output

ParameterTypeDescription
userobjectAccount settings. Reading a single setting fills only that field and leaves the rest null.
usernamestringJotform username
namestringDisplay name on the account
emailstringAccount email address
websitestringWebsite recorded on the account
time_zonestringAccount time zone, in IANA format
account_typestringURL of the plan the account is on
statusstringACTIVE, DELETED, or SUSPENDED
created_atstringAccount creation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
is_verifiedstring1 when the account email is verified
industrystringIndustry recorded on the account
companystringCompany recorded on the account
languagestringAccount interface language, e.g. en-US
avatarUrlstringAvatar image URL
usagestringURL of the monthly usage endpoint

Jotform Update Settings

Update account settings such as name, email, website, company, industry, or time zone. Only the supplied fields change.

Input

ParameterTypeRequiredDescription
apiKeystringYesJotform API key
regionstringNoJotform data residency region the API key belongs to: "us" (default), "eu", or "hipaa"
settingsNamestringNoNew display name on the account
emailstringNoNew account email address
websitestringNoNew website recorded on the account
timeZonestringNoNew account time zone in IANA format, e.g. America/New_York
companystringNoNew company recorded on the account
industrystringNoNew industry recorded on the account

Output

ParameterTypeDescription
userobjectThe account after the update. Jotform returns null for the fields it did not echo back.
usernamestringJotform username
namestringDisplay name on the account
emailstringAccount email address
websitestringWebsite recorded on the account
time_zonestringAccount time zone, in IANA format
account_typestringURL of the plan the account is on
statusstringACTIVE, DELETED, or SUSPENDED
created_atstringAccount creation time, YYYY-MM-DD HH:MM:SS
updated_atstringLast update time, YYYY-MM-DD HH:MM:SS
is_verifiedstring1 when the account email is verified
industrystringIndustry recorded on the account
companystringCompany recorded on the account
languagestringAccount interface language, e.g. en-US
avatarUrlstringAvatar image URL
usagestringURL of the monthly usage endpoint

On this page

Authentication and regions
A note on question IDs
Folders and labels
Usage Instructions
Actions
Jotform List Forms
Input
Output
Jotform Get Form
Input
Output
Jotform Create Form
Input
Output
Jotform Clone Form
Input
Output
Jotform Delete Form
Input
Output
Jotform Get Form Properties
Input
Output
Jotform Update Form Properties
Input
Output
Jotform List Form Files
Input
Output
Jotform List Questions
Input
Output
Jotform Get Question
Input
Output
Jotform Create Question
Input
Output
Jotform Update Question
Input
Output
Jotform Delete Question
Input
Output
Jotform List Form Submissions
Input
Output
Jotform List Submissions
Input
Output
Jotform Get Submission
Input
Output
Jotform Create Submission
Input
Output
Jotform Update Submission
Input
Output
Jotform Delete Submission
Input
Output
Jotform List Reports
Input
Output
Jotform List Form Reports
Input
Output
Jotform Create Report
Input
Output
Jotform Get Report
Input
Output
Jotform Delete Report
Input
Output
Jotform List Webhooks
Input
Output
Jotform Create Webhook
Input
Output
Jotform Delete Webhook
Input
Output
Jotform Get Account
Input
Output
Jotform Get Usage
Input
Output
Jotform Get History
Input
Output
Jotform Create Submissions
Input
Output
Jotform Create Questions
Input
Output
Jotform List Labels
Input
Output
Jotform Get Label
Input
Output
Jotform Create Label
Input
Output
Jotform Update Label
Input
Output
Jotform Delete Label
Input
Output
Jotform List Label Resources
Input
Output
Jotform Add Label Resources
Input
Output
Jotform Remove Label Resources
Input
Output
Jotform List Sub-Users
Input
Output
Jotform Get Settings
Input
Output
Jotform Update Settings
Input
Output