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

> Retrieve all recipients/users for a specific signing request



## OpenAPI

````yaml api-reference/v01.18.00/openapi-v01.18.00.json get /signing-requests/{id}/users
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.18.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}/users:
    get:
      tags:
        - Signing Requests
      summary: Get signing request users
      description: Retrieve all recipients/users for a specific signing request
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Signing request ID
      responses:
        '200':
          description: Signing request users retrieved successfully
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Rate limit: 200 requests per minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Remaining requests in current window
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix timestamp when rate limit resets
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/SigningRequestUser'
              example:
                results:
                  - id: user123-e89b-12d3-a456-426614174000
                    name: Alice Johnson
                    email: alice@example.com
                    first_name: Alice
                    last_name: Johnson
                    designation: Signer
                    order: 1
                    finished_on: '2024-03-15T14:30:00Z'
                    declined_on: null
                    decline_reason: null
                    phone_number: +1-555-0101
                    street_address: null
                    city: null
                    state_province: null
                    postal_code: null
                    country: null
                    title: CEO
                    company: Acme Corp
                    custom_fields: null
                    required_fields:
                      - email
                      - first_name
                    missing_fields: []
                    required_read_only_fields: []
                    ready_to_send: true
                  - id: user456-e89b-12d3-a456-426614174000
                    name: Bob Williams
                    email: bob@example.com
                    first_name: Bob
                    last_name: Williams
                    designation: Signer
                    order: 2
                    finished_on: null
                    declined_on: null
                    decline_reason: null
                    phone_number: null
                    street_address: null
                    city: null
                    state_province: null
                    postal_code: null
                    country: null
                    title: null
                    company: null
                    custom_fields: null
                    required_fields:
                      - email
                      - first_name
                      - phone_number
                    missing_fields:
                      - phone_number
                    required_read_only_fields:
                      - variable_name: contract_amount
                        field_type: number
                        has_value: false
                    ready_to_send: false
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SigningRequestUser:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the signing request user
        name:
          type: string
          description: Recipient name (combined first and last name)
        email:
          type: string
          format: email
          description: Recipient email address
        first_name:
          type: string
          nullable: true
          description: Recipient first name
        last_name:
          type: string
          nullable: true
          description: Recipient last name
        designation:
          type: string
          enum:
            - Signer
            - Approver
            - CC
          description: >-
            Role of the recipient. Signer signs the document, Approver approves
            with approval fields, CC receives a copy when complete.
        order:
          type: integer
          minimum: 1
          description: Signing order
        finished_on:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when this recipient completed all actions
        declined_on:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when this recipient declined to sign
        decline_reason:
          type: string
          nullable: true
          description: Reason provided by recipient for declining
        phone_number:
          type: string
          nullable: true
          description: Recipient phone number
        street_address:
          type: string
          nullable: true
          description: Recipient street address
        city:
          type: string
          nullable: true
          description: Recipient city
        state_province:
          type: string
          nullable: true
          description: Recipient state or province
        postal_code:
          type: string
          nullable: true
          description: Recipient postal code
        country:
          type: string
          nullable: true
          description: Recipient country
        title:
          type: string
          nullable: true
          description: Recipient job title
        company:
          type: string
          nullable: true
          description: Recipient company name
        custom_fields:
          type: object
          nullable: true
          description: Custom field values for this recipient
        required_fields:
          type: array
          items:
            type: string
          description: >-
            List of recipient data fields required for sending (based on fields
            with variable_name mappings). Always includes 'email' and
            'first_name'.
        missing_fields:
          type: array
          items:
            type: string
          description: List of required fields that are currently empty for this recipient
        required_read_only_fields:
          type: array
          items:
            type: object
            properties:
              variable_name:
                type: string
                nullable: true
                description: Variable name of the read-only field
              variable_defined_name:
                type: string
                nullable: true
                description: >-
                  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.
              field_type:
                type: string
                description: Type of the field (text, date, etc.)
              has_value:
                type: boolean
                description: Whether this read-only field has a value set
          description: >-
            List of required read-only fields that need pre-filled values before
            sending
        ready_to_send:
          type: boolean
          description: Whether this recipient has all required data filled in for sending
    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.

````