cURL
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 } ] }
Retrieve all recipients/users associated with a specific template
Documentation IndexFetch the complete documentation index at: https://docs.firma.dev/llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: https://docs.firma.dev/llms.txt
Use this file to discover all available pages before exploring further.
API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.
Template ID
Template users retrieved successfully
Show child attributes
Was this page helpful?
Suggestions
Contact support