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,
    "signed_on": "2024-03-15T14:30:00Z",
    "finished_on": "2024-03-15T14:30:00Z"
  },
  {
    "id": "user456-e89b-12d3-a456-426614174000",
    "name": "Bob Williams",
    "email": "bob@example.com",
    "designation": "Signer",
    "order": 2,
    "signed_on": null,
    "finished_on": null
  }
]

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,
CC,
Viewer
​
order
integer

Signing order

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

Timestamp when this recipient signed

​
finished_on
string<date-time> | null

Timestamp when this recipient completed all actions

⌘I