Skip to main content
GET
/
templates
/
{id}
/
users
Get template users
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/templates/{id}/users \
  --header 'Authorization: <api-key>'
[
  {
    "id": "abc12345-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "email": "john@example.com",
    "designation": "Signer",
    "order": 1
  },
  {
    "id": "def67890-e89b-12d3-a456-426614174000",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "designation": "CC",
    "order": 2
  }
]

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

Template ID

Response

Template users retrieved successfully

​
id
string<uuid>

Unique identifier for the template 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

Order in which the recipient should sign

Required range: x >= 1
⌘I