FIfirma
Signing Requests

List Signing Requests

Changed on

Retrieve a paginated list of signing requests

get/signing-requests

Request

Query parameters

pageinteger

Page number

page_sizeinteger

Items per page

namestring

Filter by signing request name (partial match, case-insensitive)

status'not_sent' | 'in_progress' | 'finished' | 'cancelled' | 'declined' | 'deleted' | 'expired'

Filter by signing request status. Supports multiple comma-separated values.

Available statuses:

  • not_sent: Request created but not yet sent to signers
  • in_progress: Sent to signers but not completed, cancelled, declined, or expired
  • finished: All signers have completed
  • cancelled: Request was cancelled by sender
  • declined: A signer declined to sign (request stopped)
  • deleted: Soft-deleted records. They are included in results by default, with this status, unless exclude_deleted=true
  • expired: Sent but past expiration time (sent_on + expiration_hours < now)

Example: ?status=in_progress,expired

Note: The expired status uses post-filtering which may have performance implications on large datasets.

exclude_deletedboolean

Set to true to leave soft-deleted signing requests out of the results. By default they are included, with status deleted.

created_afterstring date-time

Filter signing requests created after this date (ISO 8601 format)

created_beforestring date-time

Filter signing requests created before this date (ISO 8601 format)

signer_emailstring

Filter by signer email address (case-insensitive partial match)

signer_namestring

Filter by signer name (partial match, case-insensitive)

sort_by'name' | 'created_on' | 'expiration_hours' | 'sent_on' | 'finished_on'

Field to sort by

sort_order'asc' | 'desc'

Sort order

Response

Signing requests retrieved successfully

Example response

{
  "results": [
    {
      "fields": [
        {
          "format_rules": {
            "dateFormat": "MMMM dd, yyyy"
          }
        }
      ],
      "documents": [
        {
          "document_id": null,
          "position": 1,
          "label": null,
          "original_filename": null,
          "page_count": 3,
          "document_url": "https://api.firma.dev/storage/v1/object/sign/signing-request-documents/example.pdf?token=example",
          "document_url_kind": "stored",
          "document_only_hash": null
        }
      ]
    }
  ]
}

Changes

  • 7326991ebc59Revision changes
    • info

      added the new optional query request parameter exclude_deleted

  • 3a2cdde3a64fRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status