Skip to main content
GET
/
signing-requests
/
{id}
/
users
Get signing request users
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/signing-requests/{id}/users \
  --header 'Authorization: <api-key>'
[
  {
    "id": "user123-e89b-12d3-a456-426614174000",
    "name": "Alice Johnson",
    "email": "alice@example.com",
    "designation": "Signer",
    "order": 1,
    "finished_date": "2024-03-15T14:30:00Z",
    "signature_details": null
  },
  {
    "id": "user456-e89b-12d3-a456-426614174000",
    "name": "Bob Williams",
    "email": "bob@example.com",
    "designation": "Signer",
    "order": 2,
    "finished_date": null,
    "signature_details": null
  }
]

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.

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.

Path Parameters

id
string<uuid>
required

Signing request ID

Response

Signing request users retrieved successfully

id
string<uuid>

Unique identifier for the signing request user

name
string

Recipient name

email
string<email>

Recipient email address

designation
enum<string>

Role of the recipient

Available options:
Signer
order
integer

Signing order

Required range: x >= 1
finished_date
string<date-time> | null

Timestamp when this recipient completed all actions

signature_details
object

Signature details if applicable