Get Projects In Vault

This endpoint retrieves all completed signature request projects stored in the vault. It supports filtering by user type, pagination, and whether to include only user items or API-integrated projects.

HTTP Method and URL

GET {{host}}/vault/items?user_type=ENTERPRISE_API&per_page=15&page=1&user_items_only=no&api_integrated_projects_only=no

Authentication Requirements

Requires a valid user-token to be provided, typically as a header or environment variable.

Path and Query Parameters

• user_type (string): Specifies the type of user, e.g., ENTERPRISE_API.

• per_page (integer): Number of items per page.

• page (integer): Page number for pagination.

• user_items_only (string): Set to yes to include only user items, or no to include all.

• api_integrated_projects_only (string): Set to yes to include only API-integrated projects, or no to include all.

Example Request

GET {{host}}/vault/items?user_type=ENTERPRISE_API&per_page=15&page=1&user_items_only=no&api_integrated_projects_only=no
Authorization: Bearer {USER-TOKEN}

Example Successful Response

{
  "message": "Success",
  "data": [
    {
      "id": 123,
      "uuid": "abc-123-xyz",
      "client_id": 456,
      "category_id": 789,
      "project_uuid": "proj-uuid-001",
      "category_type": "Folder",
      "signatory_type": "User",
      "name": "Project Name",
      "size": "2MB",
      "status": "completed",
      "created_at": "2024-06-01T12:00:00Z",
      "actions": ["view", "download"],
      "contents": []
    }
  ],
  "meta": {
    "total": 1,
    "per_page": 15,
    "first_page": 1,
    "last_page": 1,
    "current_page": 1
  }
}

Error Responses

• 401 Unauthorized: Authentication failed or missing token.

Usage Notes

• All query parameters are required for proper filtering and pagination.

• The user-token variable must be set in your environment or provided in the request header.

• Adjust per_page and page to navigate through paginated results.

• Use user_items_only and api_integrated_projects_only to refine your search as needed.