Skip to main content
GET
@firma-dev/sdk

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.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:50

Items per page

Required range: 1 <= x <= 200
name
string

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

status
enum<string>

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 (normally hidden)
  • 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.

Available options:
not_sent,
in_progress,
finished,
cancelled,
declined,
deleted,
expired
created_after
string<date-time>

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

created_before
string<date-time>

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

signer_email
string

Filter by signer email address (exact match)

signer_name
string

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

sort_by
enum<string>
default:created_on

Field to sort by

Available options:
name,
created_on,
expiration_hours,
sent_on,
finished_on
sort_order
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Response

Signing requests retrieved successfully

Paginated list of signing requests

results
object[]
required
pagination
object
required

Pagination metadata for list responses