This document catalogs the Jotform API endpoints the integration depends on. Use it to assess the impact of any Jotform API change or deprecation, to configure firewall allow-lists, and to understand how data flows from Jotform to iPaaS.com.
API Endpoints Intro
The Jotform API is a REST API. Requests are authenticated with an API key, which may be passed as an apiKey query parameter or an APIKEY request header. The integration passes the key as the apiKey query parameter on its data-retrieval calls.
The base URL depends on your Jotform account region:
Region | Base URL |
Standard |
|
EU |
|
HIPAA |
|
Enterprise accounts may use a custom subdomain (for example https://xyz.jotform.com). The base URL you configure on the subscription's API Url setting is used for every call. In the endpoint patterns below, [Base URL] stands for the configured host.
Table of Contents
Customer Endpoints
Connection Validation
Customer Endpoints
Retrieve a Submission (GET)
[Base URL]/submission/{id}?apiKey={API Key}Retrieves a single Jotform form submission by its submission id. The submission's answers are used to build the Customer record in iPaaS.com, along with its Customer Address and Customer Category child records. The {id} value is the Jotform submission id.
Connection Validation
Validate the Connection (GET)
[Base URL]/user
Retrieves the account's user details. This lightweight endpoint is available to confirm that the API Url and API Key are valid.