GET
/
signing-requests
List Signing Requests
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "status": "draft",
      "document_url": "<string>",
      "page_count": 2,
      "expiration_hours": 2,
      "settings": {
        "allow_editing_before_sending": false,
        "attach_pdf_on_finish": true,
        "allow_download": true,
        "use_signing_order": true
      },
      "created_date": "2023-11-07T05:31:56Z",
      "updated_date": "2023-11-07T05:31:56Z",
      "sent_date": "2023-11-07T05:31:56Z",
      "finished_date": "2023-11-07T05:31:56Z",
      "cancelled_date": "2023-11-07T05:31:56Z",
      "recipients": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "jsmith@example.com",
          "designation": "<string>",
          "order": 2
        }
      ],
      "fields": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "signature",
          "required": false,
          "recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variable_name": "<string>",
          "position": {
            "x": 123,
            "y": 123,
            "width": 2,
            "height": 2
          },
          "dropdown_options": [
            "<string>"
          ],
          "format_rules": {},
          "validation_rules": {}
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "total_items": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: 'Bearer your-api-key'

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:20
Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
draft,
sent,
in_progress,
completed,
cancelled
​
search
string
Maximum length: 255

Response

200 - application/json

Signing requests retrieved

​
results
object[]
​
pagination
object