Skip to main content
POST
/
get-embedded-signing-request
Get embedded signing request data (JWT authenticated)
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/get-embedded-signing-request \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companies_workspaces_signing_requests_id": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "signingRequest": {},
  "fields": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companies_workspaces_signing_requests_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companies_workspaces_signing_requests_users_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "field_type": "text",
      "required": 0,
      "x_postion": 123,
      "y_position": 123,
      "width": 123,
      "heigh": 123,
      "page_number": 123,
      "tl_position": 123,
      "tr_position": 123,
      "bl_position": 123,
      "br_position": 123,
      "variable_name": "<string>",
      "final_value": "<string>",
      "date_default": "<string>",
      "date_signing_default": 0,
      "format_rules": {},
      "validation_rules": {},
      "dropdown_options": [
        "<string>"
      ],
      "multi_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "read_only": 0,
      "read_only_value": "<string>",
      "calculated_font_size": 123,
      "deleted": 0
    }
  ],
  "users": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "designation": "Signer",
      "order": 2,
      "finished_on": "2023-11-07T05:31:56Z",
      "declined_on": "2023-11-07T05:31:56Z",
      "decline_reason": "<string>",
      "phone_number": "<string>",
      "street_address": "<string>",
      "city": "<string>",
      "state_province": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "title": "<string>",
      "company": "<string>",
      "custom_fields": {},
      "required_fields": [
        "<string>"
      ],
      "missing_fields": [
        "<string>"
      ],
      "required_read_only_fields": [
        {
          "variable_name": "<string>",
          "field_type": "<string>",
          "has_value": true
        }
      ],
      "ready_to_send": true
    }
  ],
  "reminders": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "hours": 2,
      "subject": "<string>",
      "message": "<string>",
      "all_users": true,
      "template_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sent_on": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "workspace": {
    "name": "<string>",
    "team_email": "<string>",
    "icon_url": "<string>",
    "timezone": "<string>",
    "show_credit_cost_in_editor": true,
    "require_otp_verification": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.firma.dev/llms.txt

Use this file to discover all available pages before exploring further.

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.

Body

application/json
companies_workspaces_signing_requests_id
string<uuid>
required

ID of the signing request to retrieve

Response

Signing request retrieved successfully

Response uses camelCase keys. The signingRequest is a raw database row (not a formatted object).

signingRequest
object

Raw signing request database row. Field names use database column names (e.g., template_description, document_page_count, created_on, allow_downlaod). Integer flags (0/1) are used instead of booleans.

fields
object[]

Raw field database rows

users
object[]

Raw user database rows (note: key is 'users', not 'recipients')

reminders
object[]
workspace
object

Workspace details