Skip to main content
GET
/
templates
/
{id}
/
fields
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.templates.listTemplateFields({
    id: "id"
});
console.log(response);
curl --request GET \
--url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields \
--header 'Authorization: <api-key>'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "id": "field123-e89b-12d3-a456-426614174000",
      "type": "signature",
      "required": true,
      "recipient_id": "user123-uuid",
      "variable_name": null,
      "position": {
        "x": 100,
        "y": 200,
        "width": 200,
        "height": 50
      },
      "page_number": 1,
      "dropdown_options": null,
      "multi_group_id": null,
      "date_signing_default": false,
      "format_rules": null,
      "validation_rules": null,
      "read_only": false,
      "read_only_value": null
    },
    {
      "id": "field456-e89b-12d3-a456-426614174000",
      "type": "date",
      "required": true,
      "recipient_id": "user123-uuid",
      "variable_name": null,
      "position": {
        "x": 100,
        "y": 250,
        "width": 150,
        "height": 30
      },
      "page_number": 1,
      "dropdown_options": null,
      "multi_group_id": null,
      "date_signing_default": true,
      "format_rules": {
        "date_format": "MM/DD/YYYY"
      },
      "validation_rules": null,
      "read_only": false,
      "read_only_value": null
    }
  ]
}
{
"error": "Unauthorized",
"message": "Invalid API key"
}
{
"error": "Not Found",
"message": "The requested resource was not found"
}
{
"error": "Rate Limit Exceeded",
"message": "Too many requests. Please wait before retrying.",
"details": {
"retry_after": 45
}
}

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

List of template fields

results
object[]
required