links

Retrieve all form fields for a public link

Retrieves the PDF form fields (AcroForm) in the link's document, with the values the link has stored for them.

Not to be confused with signeeDetails on GET /links/{linkId}, which describes the signature slots. These are the document's own fillable fields — text boxes, checkboxes, dropdowns.

The values are the starting point, not answers

A public link has no single set of answers: every person who opens it fills the form independently. What you get here is what the form is pre-filled with when someone opens the link. To read what an individual signer actually entered, take a documentId from GET /links/{linkId}/documents and call GET /docs/{documentId}/field-values.

get/links/{linkId}/fields

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/links/{linkId}/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

linkIdstring uuid required

The unique identifier of the public link.

Query parameters

errorLanguage'en' | 'sv' | 'es'

Language for the error message

Response

Successfully retrieved form fields for the public link.

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.