> ## 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.

# Get Signing Request

> Retrieve a specific signing request by ID



## OpenAPI

````yaml api-reference/v01.19.00/openapi-v01.19.00.json get /signing-requests/{id}
openapi: 3.0.3
info:
  title: Firma Partner API
  description: >-
    RESTful API for document signing and template management.


    **Authentication**: All endpoints require API key authentication via the
    `Authorization` header. Use your API key directly without any prefix (e.g.,
    `your-api-key`). The Bearer prefix is optional but not required.


    **Security Features**:

    - Input validation using Zod schemas with detailed field-level error
    messages

    - RSA-256 signed JWT tokens for embedded template access


    **Rate Limiting**: Rate limits are tiered based on operation type:

    - Read operations (GET): 200 requests per minute

    - Write operations (POST/PUT/PATCH/DELETE): 120 requests per minute

    - Webhook CRUD operations: 60 requests per minute

    - Webhook test: 10 requests per minute

    - API key regeneration/expiration: 1 request per minute

    - Webhook secret rotation: 1 request per minute


    When rate limits are exceeded, the API returns a `429 Too Many Requests`
    response with headers:

    - `X-RateLimit-Limit`: Maximum requests per minute for this endpoint

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when limit resets

    - `Retry-After`: Seconds until retry is allowed


    **Error Handling**: All errors return structured JSON responses with `error`
    (human-readable message), `code` (machine-readable identifier), and
    `details` (field-level validation errors when applicable).


    **Embedded Template Integration**: The Firma Template Editor can be embedded
    in your application using a standalone JavaScript library.


    ```html

    <!-- Load the Firma Template Editor library -->

    <script
    src="https://api.firma.dev/functions/v1/embed-proxy/template-editor.js"></script>


    <script>

    // Generate JWT token via API first

    fetch('https://api.firma.dev/functions/v1/signing-request-api/generate-template-token',
    {
      method: 'POST',
      headers: {
        'Authorization': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        companies_workspaces_templates_id: 'template-id'
      })
    })

    .then(res => res.json())

    .then(data => {
      // Initialize editor with JWT token
      window.FirmaTemplateEditor.init({
        container: '#firma-editor-container',
        jwt: data.token,
        templateId: 'template-id',
        theme: 'dark',
        readOnly: false,
        onSave: (savedData) => {
          console.log('Template saved:', savedData);
        },
        onError: (error) => {
          console.error('Editor error:', error);
        },
        onLoad: (template) => {
          console.log('Template loaded:', template);
        }
      });
    });

    ```
  version: 01.19.00
  contact:
    name: API Support
    url: https://firma.com/support
servers:
  - url: https://api.firma.dev/functions/v1/signing-request-api
    description: Production API - Recommended (Current)
  - url: https://api.firma.dev/api/v1
    description: Production API - Planned
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Company information and settings
  - name: Workspaces
    description: Workspace management operations
  - name: Templates
    description: Template management operations
  - name: Signing Requests
    description: Document signing request operations
  - name: Custom Fields
    description: >-
      Custom field definition management for workspaces, templates, and signing
      requests
  - name: Webhooks
    description: Webhook configuration and management
  - name: JWT Management
    description: JWT token generation and revocation for embedded templates
  - name: Workspace Settings
    description: Workspace configuration and settings
  - name: Email Domains
    description: >-
      Email domain setup and verification for sending signing request emails
      from custom domains
  - name: Email Templates
    description: >-
      Email template management for workspace and company-level customization of
      signing request notifications
  - name: Legacy
    description: Deprecated endpoints maintained for backward compatibility
paths:
  /signing-requests/{id}:
    get:
      tags:
        - Signing Requests
      summary: Get Signing Request
      description: Retrieve a specific signing request by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Signing request retrieved successfully. Returns a detailed nested
            shape with status as an object and timestamps grouped together.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Rate limit: 200 requests per minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningRequestDetail'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SigningRequestDetail:
      type: object
      description: >-
        Detailed signing request as returned by GET /signing-requests/{id}
        (nested shape with status object and timestamps)
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the signing request
        name:
          type: string
          description: Signing request name
        template_description:
          type: string
          nullable: true
          description: Description from the template
        companies_workspaces_id:
          type: string
          format: uuid
          description: Workspace ID this signing request belongs to
        document_url:
          type: string
          format: uri
          description: Pre-signed URL to the PDF document
        document_url_expires_at:
          type: string
          format: date-time
          nullable: true
        document_page_count:
          type: integer
          minimum: 1
          description: Number of pages in the document
        expiration_hours:
          type: integer
          description: Hours until signing request expires
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            ISO 8601 timestamp when the signing request expires. Computed from
            sent_on + expiration_hours. Null if not sent yet or no
            expiration_hours set.
        credit_cost:
          type: integer
          description: Credits consumed when sent
        status:
          type: object
          description: Status flags (multiple can be true for terminal states)
          properties:
            sent:
              type: boolean
            finished:
              type: boolean
            cancelled:
              type: boolean
            declined:
              type: boolean
            expired:
              type: boolean
        timestamps:
          type: object
          description: All relevant timestamps for the signing request lifecycle
          properties:
            created_on:
              type: string
              format: date-time
            sent_on:
              type: string
              format: date-time
              nullable: true
            finished_on:
              type: string
              format: date-time
              nullable: true
            cancelled_on:
              type: string
              format: date-time
              nullable: true
            declined_on:
              type: string
              format: date-time
              nullable: true
            last_changed_on:
              type: string
              format: date-time
            last_signing_action_on:
              type: string
              format: date-time
              nullable: true
        settings:
          $ref: '#/components/schemas/SigningRequestSettings'
        use_signing_order:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        allow_download:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        allow_editing_before_sending:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        hand_drawn_only:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        attach_pdf_on_finish:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        certificate:
          type: object
          nullable: true
          description: Certificate generation status information
          properties:
            generated:
              type: boolean
              description: Whether the final certificate PDF has been generated
            generated_on:
              type: string
              format: date-time
              nullable: true
              description: Timestamp when certificate was generated
            has_error:
              type: boolean
              description: Whether there was an error generating the certificate
        final_document_download_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Signed URL to download the final signed document (PDF with
            certificate). URL expires after 1 hour.
        final_document_download_error:
          type: string
          nullable: true
          enum:
            - file_not_accessible
            - null
        document_only_download_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Signed URL to download the document-only PDF. URL expires after 1
            hour.
        document_only_download_error:
          type: string
          nullable: true
          enum:
            - file_not_accessible
            - null
        certificate_only_download_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Signed URL to download the certificate-only PDF. URL expires after 1
            hour.
        certificate_only_download_error:
          type: string
          nullable: true
          enum:
            - file_not_accessible
            - null
    SigningRequestSettings:
      type: object
      description: >-
        Signing request and template settings. All 9 fields are returned by
        every endpoint that includes settings.
      properties:
        allow_download:
          type: boolean
          description: Whether recipients can download the document
          default: true
        attach_pdf_on_finish:
          type: boolean
          description: Whether to attach PDF when signing is complete
          default: true
        allow_editing_before_sending:
          type: boolean
          description: Whether the signing request can be edited before sending
          default: false
        use_signing_order:
          type: boolean
          description: >-
            Whether signing order is enforced among recipients. When true,
            signers receive the document in sequence based on their order. When
            false, all signers receive the document simultaneously.
          default: true
        hand_drawn_only:
          type: boolean
          description: >-
            When enabled, signers can only hand-draw their signatures and cannot
            use typed/font-based signatures
          default: false
        send_signing_email:
          type: boolean
          description: Whether to send signing request notification emails to signers
          default: true
        send_finish_email:
          type: boolean
          description: Whether to send completion email when all signers finish
          default: true
        send_expiration_email:
          type: boolean
          description: Whether to send expiration notification email when request expires
          default: true
        send_cancellation_email:
          type: boolean
          description: >-
            Whether to send cancellation notification email when request is
            cancelled
          default: true
        require_otp_verification:
          type: boolean
          nullable: true
          description: >-
            Whether signers must verify their email with a one-time code before
            accessing the document. null = inherit from workspace/company
            setting.
          default: null
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
        message:
          type: string
          description: Detailed error description
        details:
          type: object
          description: Additional error details
          additionalProperties: true
  responses:
    UnauthorizedError:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    NotFoundError:
      description: Not Found - Resource does not exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource was not found
    RateLimitError:
      description: Too Many Requests - Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Maximum requests per minute
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix timestamp of reset
        Retry-After:
          schema:
            type: integer
          description: Seconds until retry allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate Limit Exceeded
            message: Too many requests. Please wait before retrying.
            details:
              retry_after: 45
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key for authentication. Use your API key directly without any prefix
        (e.g., 'your-api-key'). Bearer prefix is optional but not required.

````