Get Specific Project

Retrieves detailed information about a specific signature request project. By providing the project identifier (UUID), this endpoint returns all associated information, including document file details, timestamps (creation, update, completion, etc.), sender and signer details, and more.

HTTP Method and URL

GET
{{host}}/my/projects/:uuid?user_type=ENTERPRISE_API

Authentication Requirements

Requires a valid authentication token provided in the request headers.

Required Headers:

Authorization: Bearer {USER-TOKEN}
Content-Type: application/json

Optional Headers (for bypassing user validation):

x-api-client: {{x-api-client}}
x-api-signature: {{x-api-signature}}

Optional API Client Headers (Bypass User Validation)

The following headers are optional and can be used when you need to retrieve project details regardless of whether the authenticated user is the creator or a participant of the project:

Headers:

When to use these headers:

• Use x-api-client and x-api-signature when you want to access project details without being restricted to projects where the authenticated user is a participant.

• These headers allow system-level or administrative access to project information.

When NOT provided:

• If these headers are not included, the endpoint will validate that the authenticated user (via the Bearer token) is part of the project (either as the creator or a signer).

• Requests for projects where the user is not a participant will return a 401 Unauthorized or 400 Bad Request error.

Path and Query Parameters

Path Parameter:

• uuid — The unique identifier of the project. Example: 123e4567-e89b-12d3-a456-426614174000

Query Parameter:

• user_type — Must be set to ENTERPRISE_API

Example Request

httpGET {{host}}/my/projects/    123e4567-e89b-12d3-a456-426614174000?    user_type=ENTERPRISE_APIAuthorization: Bearer {USER-TOKEN}Content-Type: application/json

Example Successful Response

json{    "message": "",    "data": {        "access_type": "",        "id": 0,        "sender_id": 0,        "uuid":             "123e4567-e89b-12d3-a456-426614            174000",        "reference_number": "",        "type": "",        "category": "",        "source": "",        "status": "",        "name": "",        "file_name": "",        "url": "",        "description": null,        "signatory_type": "",        "validation_status": "",        "signer_mark_page": null,        "signature_timestamp_label": "",        "email_sender": "",        "email_subject": "",        "email_message": "",        "meta_data": {            "1": {                "pageNumber": 0,                "width": 0,                "height": 0            },            "pages": 0        },        "created_by": 0,        "updated_by": 0,        "sent_at": null,        "completed_at": null,        "created_at": "",        "deleted_at": null,        "schedule_date": "",        "files": [            {                "id": 0,                "name": "",                "url": "",                "size": 0            }        ],        "setting": {},        "signers": [],        "sender_details": {},        "active_signer_details": {},        "actions": []    },    "meta": {}}

Error Responses

401 Unauthorized

json{    "message": "Unauthorized access"}

404 Not Found

json{    "message": "Project not found"}

Usage Notes

• Ensure the uuid path parameter is a valid project identifier.

• The user_type query parameter must be set to ENTERPRISE_API for successful access.

• A valid bearer token is required in the Authorization header.

• The response includes comprehensive details about the project, including metadata, files, signers, and status information.

• The x-api-client and x-api-signature headers are optional. When provided, they allow retrieval of project details without validating if the authenticated user is part of the project. When omitted, the endpoint enforces that the authenticated user must be a participant (creator or signer) of the project.