Templates

Get all fields for a template

get/api/v1/templates/{id}/fields

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/templates/{id}/fields
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required

Response

valueKeystring nullable

Repeated text value key, scoped to the owning signer.

idstring required
templateIdstring required
signerRoleIdstring nullable
fieldType'signature' | 'initials' | 'date' | 'text' | 'checkbox' | 'dropdown' | 'radio' required
placement'coordinate' | 'anchor' | 'bookmark' required
pageNumbernumber required

1-based page number, or -1 for last page.

xPositionnumber nullable
yPositionnumber nullable
widthnumber required
heightnumber required
requiredboolean required
mergeFieldNamestring nullable
defaultValuestring nullable
editableboolean required

When true, a prefilled value is a suggestion the signer can change before signing.

sharedFillboolean required

One signer role owns the generated field, but until that signer signs any signer able to act may fill or correct it. Never true on signature or initials fields.

signingDateboolean nullable

Date fields only. True fills the field with the date the signer signs: the signing page shows today and the signer does not type it. False makes it an ordinary date the signer enters. Refused on any other type. Null on a date made before the flag existed: a date on the signer’s own signature line is then the date of signing.

labelstring nullable

Human-readable label shown to the signer for this field

acroFieldNamestring nullable

Embedded AcroForm field this field is linked to; generated document fields inherit the link.

acroOptionValuestring nullable

For radio-group AcroForm fields: the option this field selects.

optionsstring[] nullable

Allowed values for dropdown fields

maxLengthnumber nullable

Maximum characters accepted at fill time

inputMaskstring nullable

Input mask where # represents one digit

validationPatternstring nullable

Regex the filled value must match

validationMessagestring nullable

Signer-facing error when validationPattern does not match

dateFormatstring nullable

Date fields only: format the auto-filled date is rendered in, e.g. 'MM-DD-YYYY'

fontSizenumber nullable

Point size the value is drawn at, copied onto generated document fields. Null fits the size to the box.

textColorstring nullable

Color the value is drawn in, as #rrggbb

textAlign'left' | 'center' | 'right'

Horizontal alignment of the value inside the field box

fontFamilystring nullable

Base font the value is drawn in, copied onto generated document fields

multilineboolean required

Whether the value may contain line breaks (a multiline form field)

groupKeystring nullable
groupRequiredboolean required

Whether at least one member of this group must be selected

requiredWhenFieldIdstring uuid nullable

Id of the template field whose checked/filled state makes this field required on generated documents; null when unconditional

requiredWhenValuestring nullable

Exact controller value the condition triggers on; null means any checked/filled state

anchorTextstring nullable
anchorPosition'replace' | 'left' | 'right' | 'above' | 'below' required
anchorOffsetXnumber required
anchorOffsetYnumber required
hideAnchorboolean required
anchorMatchWholeWordboolean required
bookmarkNamestring nullable
createdAtstring date-time required
updatedAtstring date-time required

Example response

[
  {
    "inputMask": "###-##-####",
    "fontSize": 9,
    "textColor": "#000080",
    "fontFamily": "Helvetica-Bold"
  }
]

Changes

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