/

Verify form password

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://docs.fluid.app/_mock/docs/apis/public/

https://api.fluid.app/

Orders

Operations

affiliate

Operations

carts

Operations

checkout

Operations

commerce

Operations

enrollment-packs

Operations

events

Operations

lead

Operations

page

Operations

url

Operations

fingerprint

Operations

forms

Operations

Get form by public token

Request

Path

tokenstringrequired

Form public token

Example: aBcDeFgHiJkLmNoPqRsT_w

Query

access_tokenstring

Access token for password-protected forms (returned by verify_password)

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/forms/{token}?access_token=string'

Responses

password-protected form returns locked view

Bodyapplication/json

titlestringrequired

Example: "Survey Form"

descriptionstring or null

Example: "Please fill out this survey"

form_typestring

Example: "general"

form_redirectstring or null

Example: "https://example.com/thank-you"

form_stylesobject or null

form_elementsArray of objects

password_requiredbooleanrequired

Example: true

metaobject

Response

application/json

{
  "title": "Survey Form",
  "description": "Please fill out this survey",
  "form_type": "general",
  "form_redirect": "https://example.com/thank-you",
  "form_styles": {},
  "form_elements": [
    { … }
  ],
  "password_required": true,
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Submit a form response

Request

Path

tokenstringrequired

Form public token

Bodyapplication/json

form_responseobjectrequired

form_response.contactobjectrequired

form_response.contact.emailstringrequired

Example: "user@example.com"

form_response.contact.first_namestring

Example: "John"

form_response.contact.last_namestring

Example: "Doe"

form_response.responsesArray of objectsrequired

form_response.responses[].form_element_idintegerrequired

form_response.responses[].answerstringrequired

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/forms/{token}/respond' \
  -H 'Content-Type: application/json' \
  -d '{
    "form_response": {
      "contact": {
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe"
      },
      "responses": [
        {
          "form_element_id": 0,
          "answer": "string"
        }
      ]
    }
  }'

Responses

form submitted successfully

Bodyapplication/json

messagestringrequired

Example: "Form submitted successfully"

metaobject

Response

application/json

{
  "message": "Form submitted successfully",
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Verify form password

Request

Path

tokenstringrequired

Form public token

Bodyapplication/json

passwordstringrequired

Example: "secret123"

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/forms/{token}/verify_password' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "secret123"
  }'

Responses

password verified, access token returned

Bodyapplication/json

access_tokenstringrequired

Signed access token (30 min expiry)

expires_inintegerrequired

Token expiry in seconds

Example: 1800

metaobject

Response

application/json

{
  "access_token": "string",
  "expires_in": 1800,
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

media

Operations

playlist

Operations

product

Operations

root_themes

Operations

session

Operations

settings

Operations

widgets

Operations