Get a form

Returns a form with its complete field schema and settings.

Required permissions

forms.view

GET/forms/{id}

Base URLhttps://api.lynkow.com/v1

Path parameters

idstringrequired: Unique identifier

curl --request GET \
  --url 'https://api.lynkow.com/v1/forms/<id>' \
  --header 'Authorization: Bearer $API_TOKEN'

{
  "data": {
    "id": 1,
    "name": "Contact Form",
    "slug": "contact-form",
    "locale": "en",
    "schema": [
      {
        "name": "name",
        "type": "text",
        "label": "Full Name",
        "required": true,
        "placeholder": "Your name"
      },
      {
        "name": "email",
        "type": "email",
        "label": "Email Address",
        "required": true,
        "placeholder": "[email protected]"
      },
      {
        "name": "message",
        "type": "textarea",
        "label": "Message",
        "required": true,
        "placeholder": "How can we help?"
      },
      {
        "name": "rating",
        "type": "rating",
        "label": "How would you rate us?",
        "required": false
      }
    ],
    "status": "active",
    "createdAt": "2025-01-05T10:00:00.000Z",
    "updatedAt": "2025-03-20T08:15:00.000Z",
    "redirectUrl": null,
    "successMessage": "Thank you for your message!",
    "submissionCount": 134
  }
}

Feedback

Path parameters

Was this page helpful?