Skip to main content
GET
/
templates
/
{id}
/
fields
Get template fields
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields \
  --header 'Authorization: <api-key>'
[
  {
    "id": "field123-e89b-12d3-a456-426614174000",
    "field_name": "Signature",
    "field_type": "signature",
    "required": true,
    "position_x": 100,
    "position_y": 200,
    "page_number": 1
  },
  {
    "id": "field456-e89b-12d3-a456-426614174000",
    "field_name": "Date",
    "field_type": "date",
    "required": true,
    "position_x": 100,
    "position_y": 250,
    "page_number": 1
  }
]

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

​
id
string<uuid>
required

Template ID

Response

Template fields retrieved successfully

​
id
string<uuid>

Unique identifier for the field

​
field_name
string

Name of the field

​
field_type
enum<string>

Type of the field

Available options:
text,
signature,
date,
checkbox
​
required
boolean

Whether the field is required

​
position_x
number

X coordinate of field position

​
position_y
number

Y coordinate of field position

​
page_number
integer

Page number where the field is located

Required range: x >= 1
⌘I