Get Form

curl --request GET \
  --url https://api.example.com/api/open/forms/{form}

{
  "id": 123,
  "workspace_id": 123,
  "slug": "<string>",
  "title": "<string>",
  "description": "<string>",
  "visibility": "<string>",
  "tags": [
    {}
  ],
  "share_url": "<string>",
  "submissions_url": "<string>",
  "properties": [
    {}
  ],
  "removed_properties": [
    {}
  ],
  "language": "<string>",
  "font_family": "<string>",
  "theme": "<string>",
  "dark_mode": "<string>",
  "color": "<string>",
  "size": "<string>",
  "border_radius": "<string>",
  "width": "<string>",
  "presentation_style": "<string>",
  "layout_rtl": true,
  "uppercase_labels": true,
  "no_branding": true,
  "transparent_background": true,
  "cover_picture": "<string>",
  "cover_settings": {},
  "logo_picture": "<string>",
  "custom_code": "<string>",
  "custom_css": "<string>",
  "translations": {},
  "submit_button_text": "<string>",
  "submitted_text": "<string>",
  "redirect_url": "<string>",
  "re_fillable": true,
  "re_fill_button_text": "<string>",
  "database_fields_update": [
    {}
  ],
  "clear_empty_fields_on_update": true,
  "editable_submissions": true,
  "editable_submissions_button_text": "<string>",
  "confetti_on_submission": true,
  "show_progress_bar": true,
  "auto_save": true,
  "auto_focus": true,
  "enable_partial_submissions": true,
  "enable_ip_tracking": true,
  "closes_at": "<string>",
  "closed_text": "<string>",
  "is_closed": true,
  "max_submissions_count": 123,
  "max_submissions_reached_text": "<string>",
  "max_number_of_submissions_reached": true,
  "has_password": true,
  "is_password_protected": true,
  "password": "<string>",
  "can_be_indexed": true,
  "use_captcha": true,
  "captcha_provider": "<string>",
  "seo_meta": {},
  "custom_domain": "<string>",
  "views_count": 123,
  "submissions_count": 123,
  "last_edited_human": "<string>",
  "workspace": {},
  "is_pro": true,
  "is_trialing": true,
  "max_file_size": 123,
  "form_pending_submission_key": "<string>",
  "settings": {},
  "cleanings": [
    {}
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

GET

api

open

forms

{form}

Get Form

curl --request GET \
  --url https://api.example.com/api/open/forms/{form}

{
  "id": 123,
  "workspace_id": 123,
  "slug": "<string>",
  "title": "<string>",
  "description": "<string>",
  "visibility": "<string>",
  "tags": [
    {}
  ],
  "share_url": "<string>",
  "submissions_url": "<string>",
  "properties": [
    {}
  ],
  "removed_properties": [
    {}
  ],
  "language": "<string>",
  "font_family": "<string>",
  "theme": "<string>",
  "dark_mode": "<string>",
  "color": "<string>",
  "size": "<string>",
  "border_radius": "<string>",
  "width": "<string>",
  "presentation_style": "<string>",
  "layout_rtl": true,
  "uppercase_labels": true,
  "no_branding": true,
  "transparent_background": true,
  "cover_picture": "<string>",
  "cover_settings": {},
  "logo_picture": "<string>",
  "custom_code": "<string>",
  "custom_css": "<string>",
  "translations": {},
  "submit_button_text": "<string>",
  "submitted_text": "<string>",
  "redirect_url": "<string>",
  "re_fillable": true,
  "re_fill_button_text": "<string>",
  "database_fields_update": [
    {}
  ],
  "clear_empty_fields_on_update": true,
  "editable_submissions": true,
  "editable_submissions_button_text": "<string>",
  "confetti_on_submission": true,
  "show_progress_bar": true,
  "auto_save": true,
  "auto_focus": true,
  "enable_partial_submissions": true,
  "enable_ip_tracking": true,
  "closes_at": "<string>",
  "closed_text": "<string>",
  "is_closed": true,
  "max_submissions_count": 123,
  "max_submissions_reached_text": "<string>",
  "max_number_of_submissions_reached": true,
  "has_password": true,
  "is_password_protected": true,
  "password": "<string>",
  "can_be_indexed": true,
  "use_captcha": true,
  "captcha_provider": "<string>",
  "seo_meta": {},
  "custom_domain": "<string>",
  "views_count": 123,
  "submissions_count": 123,
  "last_edited_human": "<string>",
  "workspace": {},
  "is_pro": true,
  "is_trialing": true,
  "max_file_size": 123,
  "form_pending_submission_key": "<string>",
  "settings": {},
  "cleanings": [
    {}
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Retrieve detailed information about a specific form. Returns all form properties including fields, customization settings, and submission configuration.

Path Parameters

form

string

required

Form ID or slug

Response

Returns a complete form object with all properties.

Basic Information

integer

Form ID

workspace_id

integer

ID of the workspace this form belongs to

slug

string

URL-friendly form identifier

title

string

Form title

description

string

Form description (nullable)

visibility

string

Form visibility: public, draft, or closed (owner only)

Form Fields

properties

array

Array of form field definitions. Each field contains:

id: Unique field identifier
name: Field label
type: Field type (text, email, number, select, etc.)
required: Whether the field is required
Additional type-specific properties

removed_properties

array

Array of removed field definitions (owner only)

Customization

language

string

Form language code

font_family

string

Custom font family (nullable)

theme

string

Form theme: default, simple, notion, minimal, or transparent

dark_mode

string

Dark mode setting: auto, light, or dark

color

string

Primary color (hex code)

size

string

Form size: sm, md, or lg

border_radius

string

Border radius: none, small, or full

width

string

Form width: centered or full

presentation_style

string

Presentation style: classic or focused

layout_rtl

boolean

Right-to-left layout enabled

uppercase_labels

boolean

Display labels in uppercase

no_branding

boolean

OpnForm branding removed

transparent_background

boolean

Transparent background enabled

cover_picture

string

Cover image URL (nullable)

cover_settings

object

Cover image settings (focal point, brightness)

logo_picture

string

Logo image URL (nullable)

custom_code

string

Custom JavaScript code (nullable)

custom_css

string

Custom CSS styles (nullable)

translations

object

Custom translations

Submission Settings

submit_button_text

string

Custom submit button text (nullable)

submitted_text

string

Message after submission

redirect_url

string

Redirect URL after submission (owner only)

re_fillable

boolean

Multiple submissions allowed

re_fill_button_text

string

Re-fill button text (nullable)

database_fields_update

array

Fields to update on re-submission (owner only)

clear_empty_fields_on_update

boolean

Clear empty fields on update (owner only)

editable_submissions

boolean

Submissions can be edited

editable_submissions_button_text

string

Edit button text (nullable)

confetti_on_submission

boolean

Show confetti on submission

show_progress_bar

boolean

Display progress bar

auto_save

boolean

Auto-save enabled

auto_focus

boolean

Auto-focus first field

enable_partial_submissions

boolean

Partial submissions allowed

enable_ip_tracking

boolean

IP tracking enabled

Form Limits

closes_at

string

Closing timestamp (ISO 8601, nullable)

closed_text

string

Message when closed (nullable)

is_closed

boolean

Whether the form is currently closed

max_submissions_count

integer

Maximum submissions allowed (nullable)

max_submissions_reached_text

string

Message when max reached (nullable)

max_number_of_submissions_reached

boolean

Whether max submissions has been reached

Security & Privacy

has_password

boolean

Whether form is password protected

is_password_protected

boolean

Whether password protection is active

password

string

Form password (owner only)

can_be_indexed

boolean

Search engine indexing allowed (owner only)

use_captcha

boolean

CAPTCHA enabled

captcha_provider

string

CAPTCHA provider: recaptcha or hcaptcha (nullable)

SEO

seo_meta

object

SEO metadata (title, description, image)

custom_domain

string

Custom domain (nullable)

Statistics (Owner Only)

views_count

integer

Total form views (owner only)

submissions_count

integer

Total completed submissions (owner only)

last_edited_human

string

Human-readable last edit time (owner only)

Workspace & Meta

workspace

object

Workspace details

is_pro

boolean

Whether workspace has Pro features

is_trialing

boolean

Whether workspace is in trial period

max_file_size

number

Maximum file upload size in MB

form_pending_submission_key

string

Key for storing pending submissions

settings

object

Additional form settings

cleanings

array

List of Pro features that were cleaned/disabled (owner only)

created_at

string

ISO 8601 timestamp of creation

updated_at

string

ISO 8601 timestamp of last update

Example Request

curl -X GET "https://api.opnform.com/api/open/forms/contact-form-abc123" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
  "id": 1,
  "workspace_id": 1,
  "slug": "contact-form-abc123",
  "title": "Contact Form",
  "description": "Get in touch with us",
  "visibility": "public",
  "properties": [
    {
      "id": "name",
      "name": "Name",
      "type": "text",
      "required": true
    },
    {
      "id": "email",
      "name": "Email",
      "type": "email",
      "required": true
    },
    {
      "id": "message",
      "name": "Message",
      "type": "textarea",
      "required": true
    }
  ],
  "theme": "default",
  "dark_mode": "auto",
  "color": "#3B82F6",
  "size": "md",
  "border_radius": "small",
  "width": "centered",
  "presentation_style": "classic",
  "language": "en",
  "submitted_text": "Thank you for your message!",
  "confetti_on_submission": true,
  "share_url": "https://opnform.com/forms/contact-form-abc123",
  "is_closed": false,
  "has_password": false,
  "is_password_protected": false,
  "max_number_of_submissions_reached": false,
  "views_count": 150,
  "submissions_count": 42,
  "workspace": {
    "id": 1,
    "name": "My Workspace"
  },
  "is_pro": true,
  "is_trialing": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z"
}

Create Form Update Form

⌘I

Build docs developers (and LLMs) love

Get started for free Talk to us

Overview

Workspaces

Forms

Submissions

Integrations

Workspace Users

Templates

Zapier

Get Form

Path Parameters

Response

Basic Information

Form Fields

Customization

Submission Settings

Form Limits

Security & Privacy

SEO

Statistics (Owner Only)

Workspace & Meta

Example Request

Example Response

Build docs developers (and LLMs) love

Overview

Workspaces

Forms

Submissions

Integrations

Workspace Users

Templates

Zapier

​Path Parameters

​Response

​Basic Information

​Form Fields

​Customization

​Submission Settings

​Form Limits

​Security & Privacy

​SEO

​Statistics (Owner Only)

​Workspace & Meta

​Example Request

​Example Response

Build docs developers (and LLMs) love

Path Parameters

Response

Basic Information

Form Fields

Customization

Submission Settings

Form Limits

Security & Privacy

SEO

Statistics (Owner Only)

Workspace & Meta

Example Request

Example Response