GET
/
open
/
forms
curl --request GET \
  --url https://api.opnform.com/open/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": [
      "<any>"
    ],
    "properties": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "name": "<string>",
        "help": "<string>",
        "hidden": true,
        "required": true,
        "placeholder": "<string>",
        "width": "full"
      }
    ]
  }
]

​
List Forms

Retrieve every form accessible to the authenticated user across all of their workspaces.

​
Authentication & Scope

This request must be authenticated using a Personal Access Token that includes the forms-read ability.

Authorization: Bearer <token>

​
Request

GET /open/forms HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>

There are no query parameters for this endpoint.

​
Response

200 OK – Returns a JSON array of Form objects.

[
  {
    "id": 42,
    "slug": "customer-feedback",
    "title": "Customer Feedback",
    "visibility": "public",
    "properties": [
      /* form fields & layout blocks */
    ]
  }
]

403 Forbidden – The token does not include the required forms-read ability.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Response

200
application/json

Successful response

The response is of type object[].