Skip to main content
GET
/
api
/
v1
/
forms
curl -X GET "https://your-domain.com/api/v1/forms?page=1&pageSize=10&active=true" \
  -H "Authorization: Bearer sk_live_1234567890abcdef" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "form_1234567890abcdef",
      "title": "Contact Form",
      "description": "Main website contact form for customer inquiries"
    },
    {
      "id": "form_0987654321fedcba",
      "title": "Newsletter Signup",
      "description": "Email newsletter subscription form"
    },
    {
      "id": "form_abcdef1234567890",
      "title": "Support Request",
      "description": null
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "pageSize": 20,
    "totalPages": 1
  }
}

​
Overview

This endpoint returns all forms in your SitePlot instance with pagination support. You can filter results to show only active forms and control the number of results per page.

​
Authentication

​
Authorization
string
required
Bearer token with your API key: Bearer YOUR_API_KEY

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination. Must be 1 or greater.
​
pageSize
integer
default:"20"
Number of items per page. Must be between 1 and 100.
​
active
boolean
If set to true, returns only active forms. If omitted, returns all forms regardless of status.

​
Response

​
data
array
Array of form objects
​
meta
object
Pagination metadata
curl -X GET "https://your-domain.com/api/v1/forms?page=1&pageSize=10&active=true" \
  -H "Authorization: Bearer sk_live_1234567890abcdef" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "form_1234567890abcdef",
      "title": "Contact Form",
      "description": "Main website contact form for customer inquiries"
    },
    {
      "id": "form_0987654321fedcba",
      "title": "Newsletter Signup",
      "description": "Email newsletter subscription form"
    },
    {
      "id": "form_abcdef1234567890",
      "title": "Support Request",
      "description": null
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "pageSize": 20,
    "totalPages": 1
  }
}

​
Error Responses

{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid or has been revoked"
}

​
Use Cases

​
Get All Forms

Retrieve all forms in your system for administrative purposes or form management interfaces.

​
Filter Active Forms

Use the active=true parameter to get only forms that are currently accepting submissions.

​
Paginate Large Result Sets

For systems with many forms, use pagination to efficiently load forms in smaller chunks.