v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Form Fields

This endpoint returns a fields for a specific form by field key. This feature is available as part of the Standard API.

get/forms/{slug_or_id}/fields/{field_key}

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

field_keystring required

The key of the field on the form.

Response

Successfully returned a field for a single form that matched the provided field key.

status'ok'

Example response

{
  "results": {
    "field": {
      "key": "3jbh8",
      "required": true,
      "type": "address"
    }
  }
}