Skip to main content
GET
/
signing-requests
/
{id}
/
fields
Get signing request fields
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/fields \
  --header 'Authorization: <api-key>'
[
  {
    "id": "field789-e89b-12d3-a456-426614174000",
    "field_name": "Signature",
    "field_type": "signature",
    "field_value": "data:image/png;base64,iVBOR...",
    "required": true,
    "completed": true
  },
  {
    "id": "field012-e89b-12d3-a456-426614174000",
    "field_name": "Full Name",
    "field_type": "text",
    "field_value": "Alice Johnson",
    "required": true,
    "completed": true
  }
]

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

Signing request ID

Response

Signing request 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
​
field_value
string | null

Value entered or selected for this field

​
required
boolean

Whether the field is required

​
completed
boolean

Whether the field has been completed

⌘I