Skip to main content
The Forms API allows you to create, read, update, and delete forms programmatically.

​
Endpoints

MethodEndpointDescription
GET/v1/formsList all forms
GET/v1/forms/{id}Get a specific form
POST/v1/formsCreate a new form
PATCH/v1/forms/{id}Update a form
DELETE/v1/forms/{id}Delete a form

​
Query Parameters

Use these query parameters when listing forms:
ParameterTypeDescription
pageintegerPage number (default: 1)
per_pageintegerResults per page (default: 20, max: 100)
statusstringFilter by status: published, draft, or archived

​
List Forms

Returns a paginated list of all forms in your team. 
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "Contact Form",
      "slug": "contact-form",
      "type": "standard",
      "status": "published",
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-15T12:00:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}

​
Get Form

Returns detailed information about a specific form, including fields and settings. 
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Contact Form",
    "slug": "contact-form",
    "description": "Get in touch with our team",
    "type": "standard",
    "status": "published",
    "fields": [
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "type": "email",
        "label": "Email Address",
        "name": "email",
        "placeholder": "[email protected]",
        "required": true,
        "position": 0
      },
      {
        "id": "660e8400-e29b-41d4-a716-446655440002",
        "type": "textarea",
        "label": "Message",
        "name": "message",
        "required": false,
        "position": 1
      }
    ],
    "settings": {
      "redirect_url": "https://example.com/thank-you"
    },
    "created_at": "2024-01-15T10:00:00Z",
    "updated_at": "2024-01-15T12:00:00Z"
  }
}
Next: Submissions API