OpnForm

https://docs.opnform.com
Admin
OpnForm is an open-source, no-code form builder designed to empower developers and users with...
Tokens:55,304
Snippets:221
Trust Score:9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Execute OpnForm Docker Setup Script

Source: https://docs.opnform.com/deployment

This command makes the Docker setup script executable and then runs it. The script handles creating environment files, pulling Docker images, starting containers in production mode, and displaying access information.

```bash
chmod +x scripts/docker-setup.sh
./scripts/docker-setup.sh
```

--------------------------------

### Execute OpnForm Docker Development Setup Script

Source: https://docs.opnform.com/deployment/docker-development

This snippet shows how to make the OpnForm Docker setup script executable and then run it in development mode. This script handles building/pulling Docker images, starting containers, and displaying access information for the local development environment.

```bash
chmod +x scripts/docker-setup.sh
./scripts/docker-setup.sh --dev
```

--------------------------------

### Install and Register Socialite Provider (PHP/Bash)

Source: https://docs.opnform.com/contributing/new-integration

Installs a community Socialite provider using Composer and registers it within the application's event service provider for handling OAuth callbacks.

```bash
cd api && composer require socialiteproviders/newprovider
```

```php
protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        'SocialiteProviders\NewProvider\NewProviderExtendSocialite@handle',
    ],
];
```

--------------------------------

### Complete LoginForm Example (Vue)

Source: https://docs.opnform.com/front-end/forms

A full working example of a login form component using the useForm composable. It demonstrates binding form fields, handling submission with mutations, and displaying loading and error states.

```vue
<template>
  <form @submit.prevent="handleLogin">
    <TextInput
      name="email"
      :form="form"
      label="Email"
      :required="true"
      placeholder="Your email address"
    />
    
    <TextInput
      native-type="password"
      name="password"
      :form="form"
      label="Password"
      :required="true"
      placeholder="Your password"
    />
    
    <CheckboxInput
      :form="form"
      name="remember"
      label="Remember me"
    />
    
    <UButton
      type="submit"
      :loading="form.busy"
      :disabled="form.busy"
      label="Log in to continue"
    />
  </form>
</template>

<script setup>
const { login } = useAuth()
const loginMutation = login()

const form = useForm({
  email: '',
  password: '',
  remember: false
})

const handleLogin = () => {
  form.mutate(loginMutation)
    .then(() => {
      useAlert().success('Login successful!')
      // Handle redirect
    })
    .catch((error) => {
      if (error.response?.status === 422) {
        // Validation errors are automatically handled
        useAlert().error('Please check your credentials')
      } else {
        useAlert().error('Login failed. Please try again.')
      }
    })
}
</script>
```

--------------------------------

### Form Configuration Example

Source: https://docs.opnform.com/api-reference/forms/create-form

Illustrates a typical configuration object for a form, including settings for submission, security, SEO, and custom code. It also defines the structure of form properties.

```yaml
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
description: Form created
'403':
  _mintlify/placeholder:
    schemaArray:
      - type: any
        description: Forbidden – token lacks forms-write ability
    examples: {}
    description: Forbidden – token lacks forms-write ability
deprecated: false
type: path
```

--------------------------------

### Clone OpnForm Repository and Navigate

Source: https://docs.opnform.com/deployment/docker-development

This snippet demonstrates how to clone the OpnForm GitHub repository and navigate into the project directory using Git commands. It's the first step in setting up the local development environment.

```bash
git clone https://github.com/JhumanJ/OpnForm.git
cd OpnForm
```

--------------------------------

### Google OAuth Environment Configuration

Source: https://docs.opnform.com/configuration/oauth-setup

Configures environment variables for Google OAuth integration in OpnForm. Includes client ID, client secret, and optional Google Fonts API key.

```bash
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_FONTS_API_KEY=your_google_fonts_api_key (optional)
```

--------------------------------

### Recreate and Restart OpnForm Docker Containers

Source: https://docs.opnform.com/deployment

These commands are used to troubleshoot container startup issues. 'docker compose down' stops and removes existing containers, networks, and volumes, while 'docker compose up -d' recreates and starts them fresh.

```bash
# View detailed logs
docker compose logs -f

# Recreate containers
docker compose down
docker compose up -d
```

--------------------------------

### GET /websites/opnform

Source: https://docs.opnform.com/api-reference/forms/update-form

Retrieves the current configuration for the OpnForm website, including form settings and properties.

```APIDOC
## GET /websites/opnform

### Description
Retrieves the current configuration for the OpnForm website, including form settings and properties.

### Method
GET

### Endpoint
/websites/opnform

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **editable_submissions** (boolean) - Indicates if submissions are editable.
- **editable_submissions_button_text** (string) - Text for the edit submission button.
- **password** (string) - Password for the form.
- **use_captcha** (boolean) - Whether to use captcha.
- **captcha_provider** (string) - The captcha provider (e.g., recaptcha).
- **can_be_indexed** (boolean) - Whether the form can be indexed by search engines.
- **seo_meta** (object) - SEO meta information.
- **custom_code** (string) - Custom code to be included.
- **database_fields_update** (array) - Fields for database updates.
- **properties** (array of FormProperty) - An array of form properties.

#### Response Example
```json
{
  "editable_submissions": true,
  "editable_submissions_button_text": "Edit Submission",
  "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"
    }
  ]
}
```

#### Error Response (403)
- **description** (string) - Forbidden – token lacks forms-write ability
```

--------------------------------

### Send login completion message via WindowMessage composable (JavaScript)

Source: https://docs.opnform.com/contributing/new-integration

Demonstrates using the useWindowMessage composable to post a login-complete event to the opening window. Includes definition of message types and an example send call with configuration options.

```javascript
// WindowMessageTypes consistent messaging
 const WindowMessageTypes = {
    LOGIN_COMPLETE: "login-complete",
    AFTER_LOGIN: "after-login",
    OAUTH_PROVIDER_CONNECTED: "oauth-provider-connected",
};

// Usage in OAuth callback
const { send } = useWindowMessage(WindowMessageTypes.LOGIN_COMPLETE);
send(window.opener, {
    eventType: WindowMessageTypes.LOGIN_COMPLETE,
    useMessageChannel: false,
    waitForAcknowledgment: false,
});
```

--------------------------------

### Set up webhook for new submissions - OpenAPI/YAML

Source: https://docs.opnform.com/api-reference/zapier/new-submission-trigger

Defines a POST endpoint for configuring a webhook to trigger on new form submissions. Requires a bearer token for authentication, a Zapier-provided URL, and the form ID. Returns a 200 status on success.

```yaml
paths:
  path: /external/zapier/webhook
  method: post
  servers:
    - url: https://api.opnform.com
  request:
    security:
      - title: bearerAuth
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
              description: Personal Access Token
          cookie: {}
    parameters:
      path: {}
      query: {}
      header: {}
      cookie: {}
    body:
      application/json:
        schemaArray:
          - type: object
            properties:
              hookUrl:
                allOf:
                  - type: string
                    description: The URL provided by Zapier to send the submission data
              form_id:
                allOf:
                  - type: number
                    description: The ID of the form for which to trigger the webhook
            required: true
            requiredProperties:
              - hookUrl
              - form_id
        examples:
          example:
            value:
              hookUrl: <string>
              form_id: 123
  response:
    '200':
      _mintlify/placeholder:
        schemaArray:
          - type: any
            description: Webhook successfully set up
        examples: {}
        description: Webhook successfully set up
  deprecated: false
  type: path
components:
  schemas: {}
```

--------------------------------

### GET /open/workspaces

Source: https://docs.opnform.com/api-reference/workspaces/list-workspaces

Retrieves a list of all workspaces associated with the authenticated user. Requires the 'workspaces-read' permission. Authentication is handled via a Bearer token in the Authorization header.

```APIDOC
## GET /open/workspaces

### Description
This endpoint returns a list of workspaces for the authenticated user, including details such as ID, name, icon, and settings. It requires the 'workspaces-read' permission and authentication using a Personal Access Token.

### Method
GET

### Endpoint
/open/workspaces

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Request Example
```http
GET https://api.opnform.com/open/workspaces
Authorization: Bearer <personal_access_token>
```

### Response
#### Success Response (200)
- **Array of Workspaces** (array of objects) - List of workspace objects.
  - **id** (number) - The unique identifier for the workspace. Read-only.
  - **name** (string) - The name of the workspace.
  - **icon** (string) - The emoji or icon representing the workspace.
  - **settings** (object) - General settings for the workspace.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "My Marketing Team",
    "icon": "🚀",
    "settings": {}
  }
]
```

#### Error Response (403)
- **Forbidden** (any) - Access denied due to insufficient permissions.

#### Error Response Example
```json
{
  "error": "Forbidden"
}
```
```

--------------------------------

### Authenticate API Request with Curl

Source: https://docs.opnform.com/api-reference

Basic authentication example using Personal Access Token in Authorization header. Required for all API endpoints.

```bash
curl -H "Authorization: Bearer <access_token>" https://api.opnform.com/open/workspaces
```

--------------------------------

### Test Opnform Webhooks (cURL)

Source: https://docs.opnform.com/api-reference/integrations/webhook-security

This cURL example demonstrates how to test Opnform webhook functionality. It shows how to generate a sample request body, calculate the SHA256 HMAC signature using `openssl dgst` with a provided secret, and then send a POST request to the webhook endpoint including the necessary headers (`Content-Type` and `X-Webhook-Signature`).

```bash
# Generate a webhook secret for testing
SECRET="whsec_1234567890abcdefghijklmnopqr"
BODY='{"form_title":"My Form","submission":{"email":"test@example.com"}}'

# Calculate signature
SIGNATURE="sha256=$(echo -n "$BODY" | openssl dgst -sha256 -hmac "$SECRET" -hex | cut -d' ' -f2)"

# Send webhook request
curl -X POST http://localhost:3000/webhook \
  -H "Content-Type: application/json" \
  -H "X-Webhook-Signature: $SIGNATURE" \
  -d "$BODY"

```

--------------------------------

### Fetching data with TanStack Query in Vue.js

Source: https://docs.opnform.com/front-end/data-fetching

Demonstrates how to use TanStack Query to fetch data in a Vue.js component. The example shows loading, error, and success states with automatic caching and background refetching.

```vue
<script setup>
// 1️⃣ Grab the query factory from the composable
const { list } = useWorkspaces()

// 2️⃣ Call it to register the query
const {
  data: workspaces,
  isLoading,
  isError,
  error
} = list()
</script>

<template>
  <div v-if="isLoading">Loading…</div>
  <div v-else-if="isError">{{ error.message }}</div>
  <ul v-else>
    <li v-for="ws in workspaces" :key="ws.id">{{ ws.name }}</li>
  </ul>
</template>
```

--------------------------------

### Verify Opnform Webhooks (PHP/Laravel)

Source: https://docs.opnform.com/api-reference/integrations/webhook-security

This PHP example, designed for Laravel, shows how to implement webhook verification. It fetches the signature from the request headers and the raw content to compute the SHA256 HMAC signature using the `hash_hmac` function and your secret key. `hash_equals` is employed for a timing-attack-safe comparison before proceeding to process the JSON payload.

```php
<?php

use Illuminate\Http\Request;

Route::post('/webhook', function (Request $request) {
    $signature = $request->header('X-Webhook-Signature');
    $secret = env('OPNFORM_WEBHOOK_SECRET');

    if (!$signature || !$secret) {
        return response('Unauthorized: Missing signature or secret', 401);
    }

    // Get raw request body
    $rawBody = $request->getContent();

    // Calculate expected signature
    $expectedSignature = 'sha256=' . hash_hmac(
        'sha256',
        $rawBody,
        $secret
    );

    // Constant-time comparison
    if (!hash_equals($signature, $expectedSignature)) {
        return response('Unauthorized: Invalid signature', 401);
    }

    // Signature is valid, parse and process the webhook
    $data = $request->json()->all();
    \Log::info('Webhook received:', $data);

    return response('Webhook received', 200);
});

```

--------------------------------

### GET /open/forms/{id}/submissions

Source: https://docs.opnform.com/api-reference/submissions/list-submissions

Retrieves a paginated list of submissions for the specified form. Allows filtering by search term and status (completed, partial, or all). Authentication is required using a bearer token with forms-read permission. Supports up to 100 results per page.

```APIDOC
## GET /open/forms/{id}/submissions

### Description
This endpoint fetches a list of submissions for a given form, including pagination, search, and status-based filtering. It returns submission details such as ID, form ID, completion time, and response data. The base URL is https://api.opnform.com.

### Method
GET

### Endpoint
/open/forms/{id}/submissions

### Parameters
#### Path Parameters
- **id** (number) - Required - The unique ID of the form

#### Query Parameters
- **page** (number) - Optional - Pagination page number, minimum 1, default 1
- **per_page** (number) - Optional - Number of results per page, minimum 1, maximum 100, default 100
- **search** (string) - Optional - Search term to filter submissions by field values
- **status** (enum: completed, partial, all) - Optional - Filter by submission status, default all

#### Request Body
None

### Request Example
No request body for GET request. Example with query parameters:
https://api.opnform.com/open/forms/123/submissions?page=1&per_page=10&search=example&status=completed

### Response
#### Success Response (200)
- **data** (array of objects) - Array of submission objects, each containing id (number), form_id (number), completion_time (number, nullable), and data (object with responses and metadata)
- **links** (object) - Pagination links: first (string), last (string), prev (string, nullable), next (string, nullable)
- **meta** (object) - Pagination metadata: current_page (number), from (number), last_page (number), per_page (number), to (number), total (number)

#### Response Example
{
  "data": [
    {
      "id": 123,
      "form_id": 123,
      "completion_time": 123,
      "data": {}
    }
  ],
  "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
  }
}

#### Error Response (403)
- Forbidden if the token lacks forms-read permission.
```

--------------------------------

### Configure New Provider Services (PHP)

Source: https://docs.opnform.com/contributing/new-integration

Sets up the `newprovider` service configuration in `api/config/services.php` and adds corresponding environment variables to `.env.example` for client ID, secret, and redirect URI.

```php
// api/config/services.php
'newprovider' => [
    'client_id' => env('NEWPROVIDER_CLIENT_ID'),
    'client_secret' => env('NEWPROVIDER_CLIENT_SECRET'),
    'redirect' => env('APP_URL') . '/oauth/newprovider/callback',
],
```

```bash
# New Provider OAuth
NEWPROVIDER_CLIENT_ID=
NEWPROVIDER_CLIENT_SECRET=
```

--------------------------------

### GET /open/forms

Source: https://docs.opnform.com/api-reference/forms/list-forms

Retrieves a list of forms associated with the authenticated user. This endpoint is deprecated.

```APIDOC
## GET /open/forms

### Description
Retrieves a list of forms associated with the authenticated user. This endpoint is deprecated.

### Method
GET

### Endpoint
https://api.opnform.com/open/forms

### Parameters
#### Query Parameters
None

#### Headers
- **Authorization** (string) - Required - Personal Access Token (Bearer token)

### Request Body
None

### Response
#### Success Response (200)
- **id** (number) - The unique identifier for the form.
- **slug** (string) - The URL-friendly slug for the form.
- **title** (string) - The title of the form.
- **visibility** (string) - The current visibility state of the form (public, draft, closed).
- **tags** (array[string]) - Optional - Tags associated with the form.
- **language** (string) - Two-letter ISO language code.
- **custom_domain** (string) - Optional - Custom domain for the form.
- **theme** (string) - The theme of the form (default, simple, notion).
- **font_family** (string) - Optional - Font family for the form.
- **color** (string) - Color scheme for the form.
- **dark_mode** (string) - Dark mode setting (light, dark, auto).
- **width** (string) - Layout width (centered, full).
- **size** (string) - Form size (sm, md, lg).
- **border_radius** (string) - Border radius style (none, small, full).
- **layout_rtl** (boolean) - Whether the layout is right-to-left.
- **uppercase_labels** (boolean) - Whether labels are in uppercase.
- **cover_picture** (string) - Optional - URI for the cover picture.
- **logo_picture** (string) - Optional - URI for the logo picture.
- **no_branding** (boolean) - Whether to display Opnform branding.
- **transparent_background** (boolean) - Whether the background is transparent.
- **submit_button_text** (string) - Text for the submit button.
- **submitted_text** (string) - Text displayed after submission.
- **redirect_url** (string) - URL to redirect to after submission.
- **re_fillable** (boolean) - Whether the form can be refilled.
- **re_fill_button_text** (string) - Text for the refill button.
- **confetti_on_submission** (boolean) - Whether to show confetti on submission.
- **show_progress_bar** (boolean) - Whether to show a progress bar.
- **closes_at** (string) - Timestamp when the form closes.
- **closed_text** (string) - Text displayed when the form is closed.
- **max_submissions_count** (number) - Maximum number of submissions allowed.
- **max_submissions_reached_text** (string) - Text displayed when max submissions are reached.
- **auto_save** (boolean) - Whether auto-save is enabled.
- **auto_focus** (boolean) - Whether auto-focus is enabled.
- **enable_partial_submissions** (boolean) - Whether partial submissions are enabled.
- **editable_submissions** (boolean) - Whether submissions are editable.
- **editable_submissions_button_text** (string) - Text for the edit submission button.
- **password** (string) - Password for the form (if protected).
- **use_captcha** (boolean) - Whether CAPTCHA is used.
- **captcha_provider** (string) - CAPTCHA provider (recaptcha).
- **can_be_indexed** (boolean) - Whether the form can be indexed by search engines.
- **seo_meta** (object) - SEO meta information.
- **custom_code** (string) - Custom code snippet for the form.
- **database_fields_update** (array[any]) - Fields for database updates.
- **properties** (array[object]) - Form fields and their properties.
    - **id** (string) - Unique ID for the property.
    - **type** (string) - Type of the property.
    - **name** (string) - Name of the property.
    - **help** (string) - Help text for the property.
    - **hidden** (boolean) - Whether the property is hidden.
    - **required** (boolean) - Whether the property is required.
    - **placeholder** (string) - Placeholder text for the property.
    - **width** (string) - Width of the property field.

#### Response Example (200)
```json
[
  {
    "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"
      }
    ]
  }
]
```

#### Error Response (403)
- **Description**: Forbidden – token lacks forms-read ability

```json
// Example for 403 response would be here if provided in the schema
```
```

--------------------------------

### OpenAPI GET /open/workspaces/{workspaceId}/users

Source: https://docs.opnform.com/api-reference/workspace-users/list-workspace-users

This OpenAPI definition outlines the GET request to retrieve users and their roles from a workspace. It specifies the endpoint, method, server URL, required security (bearer token), path parameters (workspaceId), and the structure of the successful (200) and forbidden (403) responses, including a schema for UserWorkspaceMember.

```yaml
paths:
  path: /open/workspaces/{workspaceId}/users
  method: get
  servers:
    - url: https://api.opnform.com
  request:
    security:
      - title: bearerAuth
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
              description: Personal Access Token
          cookie: {}
    parameters:
      path:
        workspaceId:
          schema:
            - type: string
              required: true
      query: {}
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: array
            items:
              allOf:
                - $ref: '#/components/schemas/UserWorkspaceMember'
        examples:
          example:
            value:
              - id: 123
                name: <string>
                email: jsmith@example.com
                role: <string>
        description: Successful
    '403':
      _mintlify/placeholder:
        schemaArray:
          - type: any
            description: Forbidden
        examples: {}
        description: Forbidden
  deprecated: false
  type: path
components:
  schemas:
    UserWorkspaceMember:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        email:
          type: string
          format: email
        role:
          type: string
          description: Role of the user inside the workspace (admin, member, viewer).
```

--------------------------------

### GET /external/zapier/submissions/recent

Source: https://docs.opnform.com/api-reference/zapier/sample-submission-polling

Retrieves the most recent submissions for a specified form. Requires a personal access token for authentication.

```APIDOC
## GET /external/zapier/submissions/recent

### Description
Retrieves the most recent submissions for a specified form.

### Method
GET

### Endpoint
/external/zapier/submissions/recent

### Parameters
#### Query Parameters
- **form_id** (number) - Required - The ID of the form to retrieve submissions for

#### Headers
- **Authorization** (string) - Required - Personal Access Token in the format "Bearer {token}"

### Response
#### Success Response (200)
- **id** (number) - Unique submission ID
- **form_id** (number) - ID of the parent form
- **completion_time** (number) - Time taken to complete the form in seconds
- **data** (object) - Contains form field responses plus metadata (status, created_at, id)

#### Response Example
{
  "id": 123,
  "form_id": 123,
  "completion_time": 123,
  "data": {}
}
```

--------------------------------

### Build Specific OpnForm Docker Images

Source: https://docs.opnform.com/deployment

These commands allow you to build individual Docker images for the OpnForm API and UI. You can specify a tag (e.g., 'local') and the Dockerfile to use, providing flexibility for custom builds.

```docker
# Build all images
docker compose build

# Or build specific images
docker build -t opnform-api:local -f docker/Dockerfile.api .
docker build -t opnform-ui:local -f docker/Dockerfile.client .
```

--------------------------------

### GET /open/forms/{slug}

Source: https://docs.opnform.com/api-reference/forms/get-form

Retrieves the full definition and settings of a form identified by its slug. Requires a bearer token for authentication.

```APIDOC
## GET /open/forms/{slug}\n\n### Description\nRetrieves detailed information about a specific form identified by its slug. Authentication via Bearer token is required.\n\n### Method\nGET\n\n### Endpoint\nhttps://api.opnform.com/open/forms/{slug}\n\n### Parameters\n#### Path Parameters\n- **slug** (string) - Required - The URL‑friendly identifier of the form.\n\n#### Query Parameters\n_None_\n\n#### Request Body\n_None_\n\n### Request Example\n```http\nGET https://api.opnform.com/open/forms/example-form\nAuthorization: Bearer YOUR_ACCESS_TOKEN\n```\n\n### Response\n#### Success Response (200)\n- **id** (number) - The unique identifier for the form.\n- **slug** (string) - The form slug.\n- **title** (string) - The title of the form.\n- **visibility** (string) - One of `public`, `draft`, `closed`.\n- **tags** (array[string], nullable) - Tags associated with the form.\n- **language** (string) - Two‑letter ISO language code.\n- **custom_domain** (string, nullable) - Custom domain if configured.\n- **theme** (string) - One of `default`, `simple`, `notion`.\n- **font_family** (string, nullable) - Font family used.\n- **color** (string) - Primary color.\n- **dark_mode** (string) - `light`, `dark`, or `auto`.\n- **width** (string) - `centered` or `full`.\n- **size** (string) - `sm`, `md`, or `lg`.\n- **border_radius** (string) - `none`, `small`, or `full`.\n- **layout_rtl** (boolean) - Right‑to‑left layout flag.\n- **uppercase_labels** (boolean) - Uppercase label flag.\n- **cover_picture** (string, nullable) - URI of cover image.\n- **logo_picture** (string, nullable) - URI of logo image.\n- **no_branding** (boolean) - Hide OpnForm branding.\n- **transparent_background** (boolean) - Transparent background when embedded.\n- **submit_button_text** (string) - Text for the submit button (max 50 chars).\n- **submitted_text** (string) - Confirmation message after submission (max 2000 chars).\n- **redirect_url** (string, nullable) - URL to redirect after submission.\n- **re_fillable** (boolean) - Allow users to refill the form.\n- **re_fill_button_text** (string) - Text for the refill button (max 50 chars).\n- **confetti_on_submission** (boolean) - Show confetti animation.\n- **show_progress_bar** (boolean) - Display progress bar.\n- **closes_at** (string, nullable) - ISO8601 timestamp when form closes.\n- **closed_text** (string, nullable) - Message shown when closed.\n- **max_submissions_count** (integer) - Maximum allowed submissions.\n\n### Response Example\n```json\n{\n  \"id\": 12345,\n  \"slug\": \"example-form\",\n  \"title\": \"Customer Survey\",\n  \"visibility\": \"public\",\n  \"tags\": [\"survey\", \"customer\"],\n  \"language\": \"en\",\n  \"custom_domain\": null,\n  \"theme\": \"default\",\n  \"font_family\": null,\n  \"color\": \"#3498db\",\n  \"dark_mode\": \"auto\",\n  \"width\": \"centered\",\n  \"size\": \"md\",\n  \"border_radius\": \"small\",\n  \"layout_rtl\": false,\n  \"uppercase_labels\": false,\n  \"cover_picture\": null,\n  \"logo_picture\": null,\n  \"no_branding\": false,\n  \"transparent_background\": false,\n  \"submit_button_text\": \"Submit\",\n  \"submitted_text\": \"Thank you!\",\n  \"redirect_url\": null,\n  \"re_fillable\": true,\n  \"re_fill_button_text\": \"Edit\",\n  \"confetti_on_submission\": true,\n  \"show_progress_bar\": true,\n  \"closes_at\": null,\n  \"closed_text\": null,\n  \"max_submissions_count\": 0\n}\n```
```

--------------------------------

### GET /external/zapier/forms

Source: https://docs.opnform.com/api-reference/zapier/list-forms

Retrieves a list of forms within a specified workspace. This endpoint is designed for external integrations like Zapier.

```APIDOC
## GET /external/zapier/forms

### Description
Retrieves a list of forms associated with a specific workspace. This endpoint is particularly useful for integrations with tools like Zapier, allowing you to access form data programmatically.

### Method
GET

### Endpoint
https://api.opnform.com/external/zapier/forms

### Parameters
#### Query Parameters
- **workspace_id** (number) - Required - The ID of the workspace for which to list forms.

#### Headers
- **Authorization** (string) - Required - Personal Access Token. Format: `Bearer YOUR_ACCESS_TOKEN`

### Response
#### Success Response (200)
Returns an array of form objects. Each object contains details about a form, including its ID, title, visibility, language, and various configuration settings.
- **id** (number) - The unique identifier for the form.
- **slug** (string) - The URL-friendly slug for the form.
- **title** (string) - The title of the form.
- **visibility** (string) - The current visibility state of the form (e.g., `public`, `draft`, `closed`).
- **language** (string) - Two-letter ISO language code for the form.
- **custom_domain** (string) - The custom domain configured for the form, if any.
- **theme** (string) - The visual theme applied to the form.
- **font_family** (string) - The font family used in the form.
- **color** (string) - The primary color used in the form's styling.
- **dark_mode** (string) - The dark mode setting for the form.
- **width** (string) - The display width of the form.
- **size** (string) - The size of the form elements.
- **border_radius** (string) - The border radius style for the form.
- **layout_rtl** (boolean) - Whether the form layout is set to right-to-left.
- **uppercase_labels** (boolean) - Whether form labels are displayed in uppercase.
- **cover_picture** (string) - URL of the cover picture for the form.
- **logo_picture** (string) - URL of the logo picture for the form.
- **no_branding** (boolean) - Whether to remove OpnForm branding.
- **submit_button_text** (string) - Text displayed on the submit button.
- **submitted_text** (string) - Text displayed after successful submission.
- **redirect_url** (string) - URL to redirect to after submission.
- **re_fillable** (boolean) - Whether the form can be re-filled.
- **re_fill_button_text** (string) - Text for the re-fill button.
- **confetti_on_submission** (boolean) - Whether to display confetti on submission.
- **show_progress_bar** (boolean) - Whether to show a progress bar.
- **closes_at** (string) - Timestamp when the form will close.
- **closed_text** (string) - Text displayed when the form is closed.
- **max_submissions_count** (number) - Maximum number of submissions allowed.
- **max_submissions_reached_text** (string) - Text displayed when the maximum submissions are reached.
- **auto_save** (boolean) - Whether auto-save is enabled.
- **auto_focus** (boolean) - Whether auto-focus is enabled.
- **enable_partial_submissions** (boolean) - Whether partial submissions are enabled.
- **editable_submissions** (boolean) - Whether submissions can be edited.
- **editable_submissions_button_text** (string) - Text for the edit submission button.
- **password** (string) - Password for form access, if set.
- **use_captcha** (boolean) - Whether to use CAPTCHA.
- **captcha_provider** (string) - The CAPTCHA provider used.
- **can_be_indexed** (boolean) - Whether the form can be indexed by search engines.
- **seo_meta** (object) - SEO meta tags for the form.
- **custom_code** (string) - Custom code snippets for the form.
- **database_fields_update** (array) - Fields for updating the database.
- **properties** (array) - Custom properties defined for the form.

#### Response Example
```json
[
  {
    "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"
      }
    ]
  }
]
```
```
Tokens:
Raw