Get form

One form with its fields, availability and number of notification emails.

GET https://cotlet.dev/api/v1/formstack/forms/{form_id}

read

Returns the form name, folder and availability, then every field in order with its ID, label, type, whether it is required and whether it carries conditional logic. Availability says whether the form closes on a date or after a number of submissions. It reads the form as it is now, so a field added today is in the list.

Parameters

Parameters: get_form
NameTypeDescription
form_id string required string Form ID from list_forms.

Request

cURL
curl https://cotlet.dev/api/v1/formstack/forms/form_8c41d2 \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("formstack", "get_form", {"form_id":"form_8c41d2"})
Node.js
const result = await cotlet.call('formstack', 'get_form', {"form_id":"form_8c41d2"});
CLI
cotlet call formstack get_form --data '{"form_id":"form_8c41d2"}'

Example response

JSON

{
  "form_id": "5128834",
  "name": "Event registration",
  "folder": "Events",
  "availability": {
    "disable": "never"
  },
  "fields": [
    {
      "field_id": "48211325",
      "label": "Full name",
      "type": "name",
      "required": true,
      "has_logic": false
    },
    {
      "field_id": "48211330",
      "label": "Email",
      "type": "email",
      "required": true,
      "has_logic": false
    },
    {
      "field_id": "48211341",
      "label": "Dietary needs",
      "type": "dropdown",
      "required": false,
      "has_logic": true
    }
  ],
  "notification_emails": 1
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.