---
title: "Get signing request fields"
method: GET
path: "/signing-requests/{id}/fields"
tags: ["Signing Requests"]
---

# Get signing request fields

`GET /signing-requests/{id}/fields`

Retrieve all fields for a specific signing request with their values

## Path parameters

- `id` string, uuid, required

## Response `200`

Signing request fields retrieved successfully

- SigningRequestFieldListResponse — List of signing request fields
  - `results` SigningRequestField[], required
    - `id` string, uuid, required — Unique identifier for the field
    - `type` 'text' | 'signature' | 'date' | 'checkbox' | 'initial' | 'dropdown' | 'radio_buttons' | 'text_area' | 'url' | 'file' | 'stamp' | 'approval_signature' | 'approval_checkmark' | 'approval_date' — Type of the field. Clean alias for field_type.
    - `recipient_id` string, uuid, nullable — ID of the recipient assigned to this field. Clean alias for companies_workspaces_signing_requests_users_id.
    - `value` string, nullable — Final signed value of the field. Clean alias for final_value.
    - `position` object — Position and dimensions of the field on the document. All values are percentages (0-100).
      - `x` number, nullable — X position (percentage, 0-100). Clean alias for x_postion.
      - `y` number, nullable — Y position (percentage, 0-100). Clean alias for y_position.
      - `width` number, nullable — Width (percentage, 0-100).
      - `height` number, nullable — Height (percentage, 0-100). Clean alias for heigh.
    - `companies_workspaces_signing_requests_id` string, uuid — Deprecated: redundant with path parameter. ID of the signing request this field belongs to.
    - `companies_workspaces_signing_requests_users_id` string, uuid, nullable — Deprecated: use 'recipient_id' instead. ID of the recipient assigned to this field.
    - `field_type` 'text' | 'signature' | 'date' | 'checkbox' | 'initial' | 'dropdown' | 'radio_buttons' | 'text_area' | 'url' | 'file' | 'stamp' | 'approval_signature' | 'approval_checkmark' | 'approval_date', required — Deprecated: use 'type' instead. Type of the field.
    - `required` boolean — Whether the field is required.
    - `x_postion` number, nullable — Deprecated: use 'position.x' instead. X position (note: column name has typo).
    - `y_position` number, nullable — Deprecated: use 'position.y' instead. Y position of the field.
    - `width` number, nullable — Deprecated: use 'position.width' instead. Width of the field.
    - `heigh` number, nullable — Deprecated: use 'position.height' instead. Height (note: column name has typo).
    - `page_number` integer, nullable, required — Page number where the field is located (1-indexed)
    - `tl_position` number, nullable — Top-left corner position
    - `tr_position` number, nullable — Top-right corner position
    - `bl_position` number, nullable — Bottom-left corner position
    - `br_position` number, nullable — Bottom-right corner position
    - `variable_name` string, nullable — Variable name for prefilled data mapping
    - `variable_defined_name` string, nullable — Human-readable field name from the custom field definition (e.g. 'artist_name'). Only present for fields linked to a custom field definition, null otherwise.
    - `final_value` string, nullable — Deprecated: use 'value' instead. Final signed value of the field.
    - `date_default` string, nullable — Default date value
    - `date_signing_default` boolean, nullable — Whether to use signing date as default.
    - `format_rules` object, nullable — Formatting rules (e.g., date format)
    - `validation_rules` object, nullable — Validation rules for the field
    - `dropdown_options` union — Options for dropdown fields
      - string[]
      - object
    - `multi_group_id` string, uuid, nullable — Group ID for linking multiple checkbox or radio button fields together. Fields sharing the same multi_group_id behave as a mutually exclusive group (like radio buttons) - selecting one automatically deselects the others in the group. Use the same UUID across multiple fields to create a group where only one option can be selected at a time.
    - `read_only` boolean — Whether the field is read-only.
    - `read_only_value` string, nullable — Static value for read-only fields
    - `background_color` string, nullable — Background color as hex (e.g., '#FFFDE7')
    - `calculated_font_size` number, nullable — Calculated font size for the field
    - `deleted` 0 | 1 — Deprecated: internal field, will be removed in v2. Soft delete flag (0 = active, 1 = deleted).

## Other responses

- `401` — Unauthorized - Invalid or missing API key
- `404` — Not Found - Resource does not exist
- `429` — Too Many Requests - Rate limit exceeded

---

[API](https://skmtc.dev/firma/apis/firma-partner-api.md) · [All operations](https://skmtc.dev/firma/apis/firma-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/firma/firma-partner-api/revisions/5c03d6a9d080/schema)