templates

Retrieve all form fields for a template

Retrieves all the form fields defined in a specific template. This endpoint is useful for extracting form field metadata before creating a document from the template.

Supported Form Field Types

The following form field types are possible:

  • checkbox: A field that allows a binary selection (checked or unchecked).
  • combobox: A dropdown field allowing selection of one option.
  • listbox: A list field allowing selection of one or multiple options.
  • radioButton: A field that allows a single selection from a group of options.
  • textField: A single-line input field for text.

Notes:

  • Required Fields: A field is marked as required if the required property is true.
  • Read-Only Fields: A field is marked as read-only if the readOnly property is true.
  • Editable Fields: Fields with editable = true can be pre-filled when creating a document.
get/templates/{templateId}/fields

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/templates/{templateId}/fields
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token)

Path parameters

templateIdstring uuid required

The unique identifier of the template.

Response

Successfully retrieved form fields for the template.

fieldIdstring uuid

Unique identifier for the field.

namestring

The name of the form field, used as the key for API interactions.

labelstring

The display label of the form field.

type'checkbox' | 'combobox' | 'listbox' | 'radioButton' | 'textField'

The type of the form field.

valuestring nullable

The field's predefined starting value — what it was built with, not what anyone has since filled in. It is the first entry of defaultValues, and is null when the field has no predefined value.

To read what has actually been entered, use GET /docs/{documentId}/field-values on a completed document. Entered values are stored per recipient and are never returned by this endpoint.

defaultValuesstring[] nullable

List of default values for the form field.

requiredboolean

Indicates if the field is mandatory for submission.

readOnlyboolean

Indicates if the field is read-only and cannot be modified.

editableboolean

Indicates if the field is editable through the POST /docs/{documentId}/field-values endpoint.

multiLineboolean nullable

Indicates if the field supports multi-line text.

combboolean nullable

Indicates if the field uses comb formatting for text input.

pageinteger

The page index (zero-based) where the field is located.

Example response

[
  {
    "fieldId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "customer_email",
    "label": "Email Address",
    "type": "textField",
    "value": null,
    "required": true,
    "readOnly": false,
    "editable": true,
    "page": 0
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.