Sign in
Form Fields

Retrieve a Form Field

OAuth Scope

This endpoint requires the following OAuth scope read_forms.

get/formfield/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Form Field

Response

Form Field record retrieved successfully

form_uuidstring uuid

The UUID of the form this field belongs to.

namestring

The name of the form field.

field_data_jsonstring

JSON configuration for this question, including type, mandatory, choices and conditions.

sort_orderinteger

The sort order of the form field.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

{
  "form_uuid": "123e4567-196b-4438-afbf-23f94657b72b",
  "uuid": "123e4567-6ce7-4e37-bb4b-23f94df46b8b",
  "edit_date": "2026-03-01 12:00:00"
}

Changes

Changed in 3 of the 50 revisions of this API.16

  • ca9b053c43735See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • 1a0e16a1e0171See the full diff
    • ▲

      the sort_order response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

  • e859f8c27a211See the full diff
    • ○

      the security scope read_forms was added to the endpoint's security scheme oauth2

      api-security-scope-added