Forms Overview

The HoopAI Platform Forms REST API gives you programmatic access to every aspect of lead capture form management. Retrieve form configurations and paginated submission data, look up individual submissions, upload files to custom fields, schedule CSV exports, verify emails and phone numbers, and manage form categories and themes — all without leaving your integration.

Base URL

https://services.leadconnectorhq.com

Authentication

Every request requires a Bearer token and an API version header.

Authorization: Bearer <access_token>
Version: 2021-07-28

Use an access token generated with user type Account, or a Private Integration Token from an Account. See OAuth 2.0 for details.

OAuth scopes

Scope	Access granted
`forms.readonly`	Read forms and form submissions
`forms.write`	Upload files to custom fields

Quick start

List all forms for a location:

curl -X GET "https://services.leadconnectorhq.com/forms/?locationId=<locationId>&productType=form&limit=20&skip=0" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"

Endpoints

Method	Path	Description
`GET`	`/forms/`	Get forms
`GET`	`/forms/submissions`	Get forms submissions
`GET`	`/forms/multiple-forms-submissions`	Get submissions from multiple forms
`GET`	`/forms/submission/{submissionId}`	Get submission by ID
`GET`	`/forms/submission-details/{submissionId}`	Get submission details (open endpoint)
`GET`	`/forms/check-fb-lead-submission`	Check Facebook lead submission
`GET`	`/forms/forms-list`	Get forms by IDs
`POST`	`/forms/restore-version`	Restore a form version
`GET`	`/forms/widget/link`	Get widget link
`POST`	`/forms/image`	Add image in storage
`POST`	`/forms/upload-custom-files`	Upload files to custom fields
`POST`	`/forms/schedule-form-export`	Schedule form submission export as CSV
`POST`	`/forms/verify-email`	Verify email
`POST`	`/forms/verify-phone`	Verify phone
`POST`	`/forms/form-survey-event`	Fire form survey event
`GET`	`/forms/graph/data`	Get form/survey stats graph data
`GET`	`/forms/stats/count`	Get form/survey stats count
`GET`	`/forms/stats/list`	Get form/survey stats list
`POST`	`/forms/clone-from-theme`	Clone form from theme
`GET`	`/forms/theme-style/{themeId}`	Get theme style
`POST`	`/forms/{formId}/submissions/{submissionId}/download-pdf`	Initiate PDF download for submission
`GET`	`/forms/{formId}/submissions/{submissionId}/pdf-url`	Get PDF URL for submission
`GET`	`/forms/snapshots/list`	Get form/quiz snapshot list
`POST`	`/forms/snapshots/check-conflicts`	Check snapshot conflicts
`POST`	`/forms/snapshots/load-snapshot`	Load a form snapshot
`GET`	`/forms/categories/get-categories`	Get all categories
`GET`	`/forms/categories/get-category/{categoryId}`	Get category by ID
`GET`	`/forms/categories/get-themes/{categoryId}`	Get themes by category
`DELETE`	`/forms/categories/delete-category/{categoryId}`	Delete category by ID

Funnels

Forms

Surveys

Blogs

Media Library

Courses

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

​Base URL

​Authentication

​OAuth scopes

​Quick start

​Endpoints

​Related

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

Related