Skip to main content
GET
/
open
/
workspaces
/
{workspaceId}
/
forms
List Workspace Forms
curl --request GET \
  --url https://api.opnform.com/open/workspaces/{workspaceId}/forms \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}
Retrieve all forms within a specific workspace.

​
Authentication & Scope

This request must be authenticated using a Personal Access Token that includes the forms-read ability. 
Authorization: Bearer <token>

​
Request

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

​
Path Parameters

ParameterTypeDescription
workspaceIdnumberID of the workspace to retrieve forms from.

​
Query Parameters

ParameterTypeDescriptionDefault
pagenumberPage number for pagination.1

​
Response

200 OK – Returns a paginated JSON response containing Form objects. 
{
  "data": [
    {
      "id": 42,
      "slug": "customer-feedback",
      "title": "Customer Feedback",
      "visibility": "public",
      "submissions_count": 15,
      "properties": [
        /* form fields & layout blocks */
      ]
    }
  ],
  "current_page": 1,
  "per_page": 10,
  "total": 1
}
403 Forbidden – The token does not include the required forms-read ability, or you do not have access to the workspace. 404 Not Found – The workspace does not exist.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
workspaceId
number
required

ID of the workspace to retrieve forms from.

Query Parameters

​
page
number
default:1

Pagination page number

Required range: x >= 1

Response

Successful

​
data
object[]
​
links
object
​
meta
object