Get Project Count In Vault

Retrieves the total number of completed signature request documents (vault items) under a specific user account. Useful for reporting, auditing, or dashboard purposes.

HTTP Method and URL

Method: GET

URL: {{host}}/vault/items/count

Authentication Requirements

Requires a valid authentication token. Include the user-token variable in the request headers.

Path and Query Parameters

• user_type (string, required): Specifies the type of user for which the vault items count is to be retrieved. Example: ENTERPRISE_API

Example Request

GET {{host}}/vault/items/count?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}

Example Successful Response

{
  "message": "Vault items retrieved successfully.",
  "data": [
    {
      "id": 123,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "client_id": 456,
      "category_id": 789,
      "project_uuid": "p1q2r3s4-t5u6-7890-vwxy-za1234567890",
      "category_type": "DOCUMENT",
      "signatory_type": "USER",
      "name": "Signed NDA.pdf",
      "size": "1.2MB",
      "status": "completed",
      "created_at": "2024-06-01T12:34:56Z",
      "actions": ["view", "download"],
      "contents": []
    }
  ],
  "meta": {
    "total": 1,
    "per_page": 50,
    "first_page": 1,
    "last_page": 1,
    "current_page": null
  }
}

Error Responses

• 401 Unauthorized: Authentication failed or missing token. Ensure the user-token is valid and included in the request headers.

Usage Notes

• The user_type query parameter is required. Typical value: ENTERPRISE_API.

• The endpoint returns an array of vault items and metadata about the result set.

• Use the meta.total field to get the total count of vault items.

• Ensure your environment variables host and user-token are set before sending the request.