get
https://{host}/vault/items/
Get Specific Project In Vault
Retrieves a specific completed signature request document and all its associated details by providing the project identifier (UUID).
HTTP Method and URL
GET {{host}}/vault/items/:uuid?user_type=ENTERPRISE_API
Authentication Requirements
Requires a valid user-token to be included in the request headers for authentication.
Path and Query Parameters
Path Parameters:
uuid(string): The UUID of the project to retrieve. Example:{{project_uuid}}
Query Parameters:
user_type(string): Specifies the type of user. Example:ENTERPRISE_API
Example Request
GET {{host}}/vault/items/{{project_uuid}}?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}
Example Successful Response
{
"message": "Signature request project retrieved successfully.",
"data": {
"id": 12345,
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"sender_id": 67890,
"project_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"reference_number": "REF-2024-001",
"type": "signature",
"category": "contract",
"source": "portal",
"status": "completed",
"name": "NDA Agreement",
"file_name": "nda_agreement.pdf",
"url": "https://example.com/files/nda_agreement.pdf",
"description": "Non-disclosure agreement for Project X.",
"signatory_type": "individual",
"meta_data": { "department": "Legal" },
"created_by": 123,
"updated_by": 456,
"sent_at": "2024-06-01T10:00:00Z",
"completed_at": "2024-06-02T15:30:00Z",
"created_at": "2024-05-31T09:00:00Z",
"deleted_at": null,
"files": [
{
"file_id": 1,
"file_name": "nda_agreement.pdf",
"file_url": "https://example.com/files/nda_agreement.pdf"
}
],
"setting": {
"reminder": true,
"expiration_days": 7
},
"signers": [
{
"signer_id": 1,
"name": "John Doe",
"email": "[email protected]",
"status": "signed"
}
],
"sender_details": {
"name": "Jane Smith",
"email": "[email protected]"
}
},
"meta": {}
}
Error Responses
-
401 Unauthorized: Authentication failed or missing token.
{ "message": "Unauthorized. Invalid or missing token.", "data": null, "meta": {} }
Usage Notes
-
Ensure the
user-tokenvariable is set in your environment. -
The
uuidpath parameter must correspond to an existing project. -
The response may include additional fields not documented here.
-
For more details, refer to the Get Specific Project In Vault request in your collection.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…