Get template fields

Returns all field definitions for a template. Fields define where signatures, text inputs, and other data entry points are located on the document.

GET/templates/fields

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Query parameters

idstringrequired

Responses

200

fieldsTemplateField[]

Show properties

Array of TemplateField

idstringrequired

field_typeFieldTyperequired

Allowed:signaturetextdatecheckboxdropdownradioattachment

labelstring

is_requiredbooleanrequired

pageintegerrequired

Page number (1-indexed)

xnumberrequired

X position as a fraction of page width (0–1)

ynumberrequired

Y position as a fraction of page height (0–1)

widthnumberrequired

Width as a fraction of page width (0–1)

heightnumberrequired

Height as a fraction of page height (0–1)

propertiesobject

Show properties

placeholderstring

default_valuestring

optionsstring[]

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

404

Resource not found

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idquery*

Request

curl -X GET "https://api.seal.nyc/api/v1/templates/fields?id=string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.seal.nyc/api/v1/templates/fields?id=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.seal.nyc/api/v1/templates/fields?id=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "fields": [
    {
      "id": "string",
      "field_type": "signature",
      "label": "string",
      "is_required": true,
      "page": 0,
      "x": 0,
      "y": 0,
      "width": 0,
      "height": 0,
      "properties": {
        "placeholder": "string",
        "default_value": "string",
        "options": [
          "string"
        ]
      }
    }
  ]
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "title": "Document not found"
}