Passer au contenu principal
GET
/
signing-requests
/
{id}
/
fields
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

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

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

url = "https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{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/signing-requests/{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/signing-requests/{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/signing-requests/{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/signing-requests/{id}/fields")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{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": "field789-e89b-12d3-a456-426614174000",
      "type": "signature",
      "recipient_id": "user456-e89b-12d3-a456-426614174000",
      "required": true,
      "read_only": false,
      "value": "data:image/png;base64,iVBOR...",
      "position": {
        "x": 100.5,
        "y": 200.75,
        "width": 200,
        "height": 50
      },
      "page_number": 1,
      "variable_name": null,
      "variable_defined_name": null,
      "companies_workspaces_signing_requests_id": "sr123-e89b-12d3-a456-426614174000",
      "companies_workspaces_signing_requests_users_id": "user456-e89b-12d3-a456-426614174000",
      "field_type": "signature",
      "x_postion": 100.5,
      "y_position": 200.75,
      "width": 200,
      "heigh": 50,
      "final_value": "data:image/png;base64,iVBOR...",
      "deleted": 0
    },
    {
      "id": "field012-e89b-12d3-a456-426614174000",
      "type": "text",
      "recipient_id": "user456-e89b-12d3-a456-426614174000",
      "required": true,
      "read_only": false,
      "value": "Alice Johnson",
      "position": {
        "x": 150,
        "y": 300,
        "width": 250,
        "height": 30
      },
      "page_number": 1,
      "variable_name": "full_name",
      "variable_defined_name": null,
      "companies_workspaces_signing_requests_id": "sr123-e89b-12d3-a456-426614174000",
      "companies_workspaces_signing_requests_users_id": "user456-e89b-12d3-a456-426614174000",
      "field_type": "text",
      "x_postion": 150,
      "y_position": 300,
      "width": 250,
      "heigh": 30,
      "final_value": "Alice Johnson",
      "deleted": 0
    }
  ]
}
{
  "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
  }
}

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

id
string<uuid>
requis

ID de la demande de signature

Réponse

Champs de la demande de signature récupérés avec succès

Liste des champs de la demande de signature

results
object[]
requis