Retrieve Project Signers
This endpoint retrieves a list of all users (signers) and their associated information for a specific active signature request document. By providing the project identifier (UUID), you can obtain details about each signer involved in the project.
HTTP Method and URL
GET
{{host}}/projects/:uuid/signers?user_type=ENTERPRISE_API
Authentication Requirements
A valid authentication token is required in the request headers.
Headers:
plaintextAuthorization: Bearer {USER-TOKEN}Content-Type: application/json
Path and Query Parameters
Path Parameter:
uuid— The unique identifier of the project.
Query Parameter:
user_type— Must be set toENTERPRISE_API.
Example Request
httpGET {{host}}/projects/{{project-uuid}}/ signers?user_type=ENTERPRISE_APIAuthorization: Bearer {USER-TOKEN}Content-Type: application/json
Example Successful Response
json{ "message": "", "data": [ { "id": 0, "project_id": 0, "client_id": 0, "email": "", "first_name": "", "last_name": "", "photo": "", "type": "", "sequence": 0, "status": "", "deliver_status": "", "in_contact": true, "color_code": "", "sent_at": null, "opened_at": null, "signed_at": null, "created_at": "", "deleted_at": null, "signature": "", "signature_source": "", "initial": "", "initial_source": "", "marks": [] } ], "meta": {}}
Error Responses
401 Unauthorized
json{ "message": "Unauthorized access"}
400 Project Not Found
json{ "message": "Project not found"}
Usage Notes
-
Ensure the
uuidpath parameter is a valid project identifier. -
The
user_typequery parameter must be set toENTERPRISE_API. -
A valid bearer token must be included in the
Authorizationheader. -
The response contains an array of signer objects, each with detailed information about the signer’s status and activity within the project.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
