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>'
{
  "results": [
    {
      "id": "abc12345-e89b-12d3-a456-426614174000",
      "name": "John Doe",
      "email": "john@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "designation": "Signer",
      "order": 1,
      "phone_number": null,
      "street_address": null,
      "city": null,
      "state_province": null,
      "postal_code": null,
      "country": null,
      "title": null,
      "company": null,
      "required_fields": [
        "email",
        "first_name"
      ],
      "missing_fields": [],
      "required_read_only_fields": [],
      "ready_to_send": true
    },
    {
      "id": "def67890-e89b-12d3-a456-426614174000",
      "name": null,
      "email": null,
      "first_name": null,
      "last_name": null,
      "designation": "Signer",
      "order": 2,
      "phone_number": null,
      "street_address": null,
      "city": null,
      "state_province": null,
      "postal_code": null,
      "country": null,
      "title": null,
      "company": null,
      "required_fields": [
        "email",
        "first_name",
        "phone_number"
      ],
      "missing_fields": [
        "email",
        "first_name",
        "phone_number"
      ],
      "required_read_only_fields": [
        {
          "variable_name": "contract_date",
          "field_type": "date"
        }
      ],
      "ready_to_send": false
    }
  ]
}

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

results
object[]