curl --request GET \
--url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/fields \
--header 'Authorization: <api-key>'{
"results": [
{
"id": "field789-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_id": "sr123-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_users_id": "user456-e89b-12d3-a456-426614174000",
"field_type": "signature",
"required": 1,
"x_postion": 100.5,
"y_position": 200.75,
"width": 200,
"heigh": 50,
"page_number": 1,
"final_value": "data:image/png;base64,iVBOR...",
"read_only": 0,
"deleted": 0
},
{
"id": "field012-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_id": "sr123-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_users_id": "user456-e89b-12d3-a456-426614174000",
"field_type": "text",
"required": 1,
"x_postion": 150,
"y_position": 300,
"width": 250,
"heigh": 30,
"page_number": 1,
"variable_name": "full_name",
"final_value": "Alice Johnson",
"read_only": 0,
"deleted": 0
}
]
}curl --request GET \
--url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/fields \
--header 'Authorization: <api-key>'{
"results": [
{
"id": "field789-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_id": "sr123-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_users_id": "user456-e89b-12d3-a456-426614174000",
"field_type": "signature",
"required": 1,
"x_postion": 100.5,
"y_position": 200.75,
"width": 200,
"heigh": 50,
"page_number": 1,
"final_value": "data:image/png;base64,iVBOR...",
"read_only": 0,
"deleted": 0
},
{
"id": "field012-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_id": "sr123-e89b-12d3-a456-426614174000",
"companies_workspaces_signing_requests_users_id": "user456-e89b-12d3-a456-426614174000",
"field_type": "text",
"required": 1,
"x_postion": 150,
"y_position": 300,
"width": 250,
"heigh": 30,
"page_number": 1,
"variable_name": "full_name",
"final_value": "Alice Johnson",
"read_only": 0,
"deleted": 0
}
]
}API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.
Signing request ID
Signing request fields retrieved successfully
Show child attributes
Was this page helpful?