Skip to main content
GET
/
external
/
zapier
/
forms
List Forms
curl --request GET \
  --url https://api.opnform.com/external/zapier/forms \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "slug": "<string>",
    "title": "<string>",
    "visibility": "public",
    "tags": [
      "<string>"
    ],
    "language": "<string>",
    "custom_domain": "<string>",
    "theme": "default",
    "font_family": "<string>",
    "color": "<string>",
    "dark_mode": "light",
    "width": "centered",
    "size": "sm",
    "border_radius": "none",
    "layout_rtl": true,
    "uppercase_labels": true,
    "cover_picture": "<string>",
    "logo_picture": "<string>",
    "no_branding": true,
    "transparent_background": true,
    "submit_button_text": "<string>",
    "submitted_text": "<string>",
    "redirect_url": "<string>",
    "re_fillable": true,
    "re_fill_button_text": "<string>",
    "confetti_on_submission": true,
    "show_progress_bar": true,
    "closes_at": "2023-11-07T05:31:56Z",
    "closed_text": "<string>",
    "max_submissions_count": 2,
    "max_submissions_reached_text": "<string>",
    "auto_save": true,
    "auto_focus": true,
    "enable_partial_submissions": true,
    "editable_submissions": true,
    "editable_submissions_button_text": "<string>",
    "password": "<string>",
    "use_captcha": true,
    "captcha_provider": "recaptcha",
    "can_be_indexed": true,
    "seo_meta": {},
    "custom_code": "<string>",
    "database_fields_update": [
      "<unknown>"
    ],
    "properties": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "name": "<string>",
        "help": "<string>",
        "hidden": true,
        "required": true,
        "placeholder": "<string>",
        "width": "full"
      }
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.opnform.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Query Parameters

​
workspace_id
number
required

The ID of the workspace for which to list forms

Response

200 - application/json

Successful response

​
id
number
read-only

The unique identifier for the form.

​
slug
string
read-only

The URL-friendly slug for the form.

​
title
string

The title of the form.

​
visibility
enum<string>

The current visibility state of the form.

Available options:
public,
draft,
closed
​
tags
string[] | null
​
language
string

Two-letter ISO language code.

​
custom_domain
string | null
​
theme
enum<string>
Available options:
default,
simple,
notion
​
font_family
string | null
​
color
string
​
dark_mode
enum<string>
Available options:
light,
dark,
auto
​
width
enum<string>
Available options:
centered,
full
​
size
enum<string>
Available options:
sm,
md,
lg
​
border_radius
enum<string>
Available options:
none,
small,
full
​
layout_rtl
boolean
​
uppercase_labels
boolean
​
cover_picture
string<uri> | null
​
logo_picture
string<uri> | null
​
no_branding
boolean

Whether to hide the OpnForm branding.

​
transparent_background
boolean

Transparent background when form is embedded.

​
submit_button_text
string
Maximum string length: 50
​
submitted_text
string
Maximum string length: 2000
​
redirect_url
string<uri> | null
​
re_fillable
boolean
​
re_fill_button_text
string
Maximum string length: 50
​
confetti_on_submission
boolean
​
show_progress_bar
boolean
​
closes_at
string<date-time> | null
​
closed_text
string | null
​
max_submissions_count
integer | null
Required range: x >= 1
​
max_submissions_reached_text
string | null
​
auto_save
boolean
​
auto_focus
boolean
​
enable_partial_submissions
boolean
​
editable_submissions
boolean
​
editable_submissions_button_text
string
Maximum string length: 50
​
password
string | null
​
use_captcha
boolean
​
captcha_provider
enum<string>
Available options:
recaptcha,
hcaptcha
​
can_be_indexed
boolean
​
seo_meta
object
​
custom_code
string | null
​
database_fields_update
any[] | null
​
properties
object[]

An array of field and layout blocks that make up the form.