JotForms Pipe

This article is still being written, please check back soon. 

The JotForm API makes it possible to connect to your form data without using the JotForm web site.

To get started using JotForm API you need a valid API key. Obtaining an API key is very simple.

1. Go to My Account
2. Navigate to API Section
3. Create a new API Key

Global Parameters

There are Global Parameters in this pipe.

• apikey

API Calls

All the API Calls in this Pipe can be customized, but we've added several to help you get started and expedite the time needed to get you up and running with some of the basic uses. 

Users

• Register Users
• Updating User Setting 
• Login Users
• Get Monthly Users Usage
• Get Users Setting

Register Users

Allows to register a users.

URL

First you can pass a URL and Method in the overview tab for register a user. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/user/register

Parameters

Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.

• username -  Set unique username ( Required ).
• password - Password for user register ( Required ).
• email - User email address ( Required ).

Headers

Here required header value must be included in headers tab. Assign parameter like {apikey} that created at global parameter tab. 

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for register user. Here {username}, {password} and {email} is assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Username
• Name
• Email
• Website
• Status
• Created at
• Updated at
• Verified
• Usage
• Card Forms

Update User Setting

Allows to update a user setting.

URL

First you can pass a URL and Method in the overview tab for update a user setting. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/user/settings

Parameters

Set Parameters must be included in parameters tab.

• email - User email address ( Required ).
• website - Name of website ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for updating user setting. Here {email} and {website} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Username
• Name
• Email
• Website
• Status
• Created at
• Updated at
• Is verified

Login Users

Allows to login user with given credentials.

URL

First you can pass a URL and Method in the overview tab for login user with given credentials. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/user/register

Parameters

Set Parameters must be included in parameters tab.

• username - User unique identifier ( Required ).
• password - Password for user register ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for login user. Here {username} and {password} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Username
• Name
• Email
• Website
• Status
• Created at
• Updated at
• Is verified

Get Monthly User Usage

Get number of form submissions received this month. Also, get number of SSL form submissions, payment form submissions and upload space used by user.

URL

First you can pass a URL and Method in the overview tab for getting a users usage detail. The required URL and method that must be included below :

• Method : GET
• Request URL : https://api.jotform.com/user/usage

Parameters

Here parameters is not required.

Headers

Header Parameters must be included below. 

• apikey

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

Response

Built in responses already added are below. 

• Submissions
• Ssl submissions
• Payments
• Uploads
• Total submissions
• Mobile submissions
• Views
• Api
• Form count

Get User Settings

Allow to get user's settings.

URL

First you can pass a URL and Method in the overview tab for getting a users detail. The required URL and method that must be included below :

• Method : GET
• Request URL : https://api.jotform.com/user/settings

Parameters

Here parameters is not required.

Headers

Header Parameters must be included below. 

• apikey

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

Response

Built in responses already added are below. 

• Username
• Name
• Email
• Website
• Status
• Created_at
• Updated_at
• Is verified
• Login To Get Submissions
• Login To View UploadedFiles
• Login To View SubmissionRSS

Form

• Create a Form
• Get a Form Details 
• Clone a Form
• Add New Question to Form
• Get Details About a Question
• Edit a Single Question
• Delete a Form
• Delete Form Question
• Add or Edit a Properties of Form

Create a Form

Allows to create form.

URL

First you can pass a URL and Method in the overview tab for create a form. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/user/forms

Parameters

Set Parameters must be included in parameters tab.

• Question type - Question field type ( Required ).
• Question label - Label of your question ( Required ).
• Question Order - Order defines the location of the question in the form ( Required ).
• Question slug - Slug of question label ( Required ).
• Form Title - Form Title ( Required ).

Note: Question type allow control_textbox, control_textarea, control_dropdown control_radio, control_checkbox, control_fileupload, control_fullname, control_email and control_datetime.

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create a form. Here {question_type}, {question_label}, {question_order}, {question_slug} and {form_title} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Id
• Username
• Form Title
• Status
• Created_at
• Updated_at
• Type
• Url

Get Form Detail

Get basic information about a form. Use /form/{id}/questions to get the list of questions.

URL

First you can pass a URL and Method in the overview tab for getting a form detail. The required URL and method that must be included below :

• Method : GET
• Request URL : https://api.jotform.com/form/{formID}

Parameters

Parameters must be included below. 

• formID - Form Unique identifier (required). 

Headers

Header Parameters must be included below. 

• apikey

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

Response

Built in responses already added are below. 

• Id
• Username
• Title
• Status
• Created_at
• Updated_at
• Last_submission
• New
• Count
• Type
• Url

Clone a Form

Clone a single form.

URL

First you can pass a URL and Method in the overview tab for clone a form. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/form/{formID}/clone

Parameters

Set Parameters must be included in parameters tab.

• formID - Form unique id ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Here a no need to add any form-data in request tab because of {formID} parameter assign in request url.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Id
• Username
• Title
• Status
• Created_at
• Updated_at
• Last submission
• New
• Count
• Type
• Url

Add New Question to Form

Add new question to specified form. Form questions might have various properties. Examples: Is it required? Are there any validations such as 'numeric only'?

URL

First you can pass a URL and Method in the overview tab for create a question in form. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/form/{formID}/questions

Parameters

Set Parameters must be included in parameters tab.

• formID - Form unique id ( Required ).
• Question type - Question field type ( Required ).
• Question label - Label of your question ( Required ).
• Question Order - Order defines the location of the question in the form ( Required ).
• Question slug - Slug of question label ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create a question in form. Here {question[type]}, {question[text]}, {question[order]} and {question[name]} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Question type
• Question text
• Question order
• Question slug
• Question id

Get Details About a Question

Allow to get detail about a question.

URL

First you can pass a URL and Method in the overview tab for getting a question detail. The required URL and method that must be included below :

• Method : GET
• Request URL : https://api.jotform.com/form/{formID}/question/{questionID}

Parameters

Parameters must be included below. 

• Form id - Form unique identifier (required). 
• Question id - Question unique identifier (required)

Headers

Header Parameters must be included below. 

• apikey

Request

Here a no need to add any form-data in request tab because of {formID} and {questionID} parameter assign in request url.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

Response

Built in responses already added are below. 

• Question type
• Question text
• Question order
• Question slug
• Question id

Edit a Single Question

Edit a question property or add a new one. Form questions might have various properties. Examples: Is it required? Are there any validations such as 'numeric only'?

URL

First you can pass a URL and Method in the overview tab for edit a question in form. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/form/{formID}/question/{questionID}

Parameters

Set Parameters must be included in parameters tab.

• Form id - Form Unique id ( Required ).
• Question id - Question unique id ( Required ).
• Questions validation - Validation entry format enum None, Email, AlphaNumeric, Alphabetic, Numeric, URL ( Required ).
• Questions required - Question is required allow Yes or No ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for update a question in form. Here {questions[1][validation]} and {questions[1][required]} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Question type

Delete a Form

Allow to delete a form.

URL

First you can pass a URL and Method in the overview tab for remove a form. The required URL and method that must be included below :

• Method :DELETE
• Request URL : https://api.jotform.com/form/{formID}

Parameters

Parameters must be included below. 

• Form id - Form unique identifier (required). 

Headers

Header Parameters must be included below. 

• apikey

Request

Here a no need to add any form-data in request tab because of {formID} parameter assign in request url.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

Response

Built in responses already added are below. 

• Id
• Username
• Title
• Status

Delete Form Question

Allow to delete a question.

URL

First you can pass a URL and Method in the overview tab for remove a question. The required URL and method that must be included below :

• Method :DELETE
• Request URL : https://api.jotform.com/form/{formID}/question/{questionID}

Parameters

Parameters must be included below. 

• Form id - Form unique identifier (required).
• Question id - Question unique identifier ( required ).  

Headers

Header Parameters must be included below. 

• apikey

Request

Here a no need to add any form-data in request tab because of {formID} and {questionID} parameter assign in request url.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

Response

Built in responses already added are below. 

• Success Message

Add or Edit a Properties of Form

Edit a form property or add a new one.

URL

First you can pass a URL and Method in the overview tab for change or add properties of form. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/form/{formID}/properties

Parameters

Set Parameters must be included in parameters tab.

• Form Id - Form unique id ( Required ).
• Thank url - Thank you url.
• Label width - Set a  label width.
• Form Width - Form width.

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create or update form properties. Here {properties[thankurl]}, {properties[formWidth]}, and {properties[labelWidth]} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Thank url
• Form width
• Label width
• Form id

Create a Webhook

Webhook can be used to send form submission data as an instant notification.

URL

First you can pass a URL and Method in the overview tab for create a Webhook. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/form/{formID}/webhooks

Parameters

Set Parameters must be included in parameters tab.

• Form Id - Form unique id ( Required ).
• Webhook URL - Webhook URL is where form data will be posted when form is submitted ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create webhook. Here {title} and {webhookURL} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Response Code
• Message 

Retrieve a Webhook

Retrieve a webhook of a specific form

URL

First you can pass a URL and Method in the overview tab for retrieve a webhook of particular form. The required URL and method that must be included below :

• Method :GET
• Request URL : https://api.jotform.com/form/{formID}/webhooks

Parameters

Set Parameters must be included in parameters tab.

• Form Id - Form Unique id ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Response Code
• Message 

Delete a Webhook

Delete a webhook of a specific form

URL

First you can pass a URL and Method in the overview tab for delete a webhook of particular form. The required URL and method that must be included below :

• Method : DELETE
• Request URL : https://api.jotform.com/form/{formID}/webhooks

Parameters

Set Parameters must be included in parameters tab.

• Form Id - Form unique id ( Required ).
• Webhook id - Webhook unique id ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Note : Webhook id consider as index ( see screen shot indicate webhook id in red color circle ).

Response

Built in responses already added are below. 

• Response Code
• Message 

Report

• Create a Report

Create a Report

Create new report of a form with intended fields, type and title.

URL

First you can pass a URL and Method in the overview tab for create a report. The required URL and method that must be included below :

• Method : POST
• Request URL : https://api.jotform.com/form/{formID}/reports

Parameters

Set Parameters must be included in parameters tab.

• Form Id - Form unique id ( Required ).
• List type - List type to allow csv, excel, grid, table and rss ( Required ).
• Title - Set a title of report ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create report. Here {title} and {list_type} assigned parameters that created in parameters tab.

Note: Here request type use as form-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Id
• Form id
• Title
• Fields
• List type
• Status
• Settings
• Password
• Url

Submission

• Add Submissions to the Form
• Get Submission Data
• Delete a Submission

Add Submissions to the Form

Add Submissions to the Form. Submit data to this form using the API. 

URL

First you can pass a URL and Method in the overview tab for add submission. The required URL and method that must be included below :

• Method :PUT
• Request URL : https://api.jotform.com/form/{formID}/submissions

Parameters

Set Parameters must be included in parameters tab.

• Form Id - Form Unique id ( Required ).
• Question id - Question unique id ( Required ).
• Question answer - Question answer ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for add submission. Here {question_id} and {question_answer} assigned parameters that created in parameters tab.

Note: Here request type use as raw-data.

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Submission id
• Url

Get Submission Data

Retrieve a submission of a specific form.

URL

First you can pass a URL and Method in the overview tab for retrieve a submission of a specific form. The required URL and method that must be included below :

• Method :GET
• Request URL : https://api.jotform.com/submission/{submissionID}

Parameters

Set Parameters must be included in parameters tab.

• submissionID - Submission Unique id ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Response Code
• Message
• Submission id
• Form id
• Ip
• Created Date
• Status 

Delete a Submission

Delete a Submission of a specific form

URL

First you can pass a URL and Method in the overview tab for delete a submission of particular form. The required URL and method that must be included below :

• Method : DELETE
• Request URL : https://api.jotform.com/submission/{submissionID}

Parameters

Set Parameters must be included in parameters tab.

• Submission id - Submission Unique id ( Required ).

Headers

Header Parameters must be included below. 

• apikey

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

Response

Built in responses already added are below. 

• Response Code
• Message
• Content