Skip to main content
GET
/
forms
/
{id}
/
fields
List form fields
curl --request GET \
  --url https://api.heffl.com/api/v2/forms/{id}/fields \
  --header 'x-api-key: <api-key>'
{
  "formId": "<string>",
  "formTitle": "<string>",
  "fields": [
    {
      "key": "<string>",
      "label": "<string>",
      "dataType": "<string>",
      "required": true,
      "type": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "multiple": true
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Form ID (frm_ prefix)

Response

OK

formId
string
required

Form ID (frm_ prefix)

formTitle
string
required

Form title

fields
object[]
required

Ordered list of fields on the form