> For the complete documentation index, see [llms.txt](https://docs.pareto.credit/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pareto.credit/developers/api/vaults.md).

# Vaults

Vaults are the core contracts of the Pareto protocol. They represent on-chain vehicles that accept user deposits, deploy strategies, and accrue yield over time.

Each vault is tied to a specific strategy, chain, and token, and is managed by one or more operators.

## Structure

Each vault object includes:

* `_id` *(string)* — Unique identifier
* `tokenId` *(string)* — Accepted token reference
* `chainId` *(string)* — Blockchain network identifier
* `typeId` *(string)* — Reference to vault type
* `categoryId` *(string)* — Vault category
* `operatorIds` *(array\[string])* — Managing entities
* `name` *(string)* — Name of the vault
* `address` *(string)* — On-chain vault contract address
* `symbol` *(string)* — Symbol of the share token
* `protocol` *(string)* — Strategy protocol (e.g., AaveV2, Clearpool, Morpho, etc.)
* `contractType` *(string)* — Contract logic (e.g., BestYield, CDO, CDO\_EPOCH)
* `abi` *(array)* — ABI definition
* `description`, `shortDescription`, `caption` *(object)* — Multilingual metadata
* `keyInfo` *(array)* — Key-value UI information
* `visibility` *(string)* — One of: `PUBLIC`, `RESTRICTED`, `HIDDEN`
* `status` *(string)* — Deployment status (e.g., `READY`, `PAUSED`, `DISABLED`)
* `feePercentage` *(number)* — Vault fee as percentage
* `createdAt`, `updatedAt` *(string)* — ISO timestamps
* `createdBy`, `updatedBy` *(string)* — System actor IDs

## Endpoints

{% openapi src="/files/qfgujM7qOV6XUfxXLdaa" path="/vaults" method="get" %}
[Vaults.yaml](https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2FAyYSrRq1aBgsILZyllL0%2FVaults.yaml?alt=media\&token=f5705c11-672f-431b-af13-054a7da5d9b1)
{% endopenapi %}

{% openapi src="/files/qfgujM7qOV6XUfxXLdaa" path="/vaults/{vaultId}" method="get" %}
[Vaults.yaml](https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2FAyYSrRq1aBgsILZyllL0%2FVaults.yaml?alt=media\&token=f5705c11-672f-431b-af13-054a7da5d9b1)
{% endopenapi %}

{% openapi src="/files/qfgujM7qOV6XUfxXLdaa" path="/vaults/performances" method="get" %}
[Vaults.yaml](https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2FAyYSrRq1aBgsILZyllL0%2FVaults.yaml?alt=media\&token=f5705c11-672f-431b-af13-054a7da5d9b1)
{% endopenapi %}

{% openapi src="/files/qfgujM7qOV6XUfxXLdaa" path="/vaults/{vaultId}/integrations" method="get" %}
[Vaults.yaml](https://4223418165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVSPclqPyChB4NMxFfG2X%2Fuploads%2FAyYSrRq1aBgsILZyllL0%2FVaults.yaml?alt=media\&token=f5705c11-672f-431b-af13-054a7da5d9b1)
{% endopenapi %}