---
title: "Get vault"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › entities

`GET /v2/entities/{entityId}/collections/{id}/vault`

## Path parameters

- `entityId` (`collection-get-vault.path.entityId`; string, required)
  - format `uuid`
- `id` (`collection-get-vault.path.id`; string, required)
  - format `uuid`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/entities/<entityId>/collections/<id>/vault'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/entities/<entityId>/collections/<id>/vault';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/entities/<entityId>/collections/<id>/vault"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
    "status": "not_vaulted",
    "chainId": 0,
    "chainName": "string",
    "tokenModuleAddress": "string",
    "tokenId": "string",
    "initializeTransactionHash": "string",
    "explorerUrl": "http://example.com",
    "lastError": "string",
    "enabledAt": "2019-08-24T14:15:22Z",
    "activatedAt": "2019-08-24T14:15:22Z",
    "passes": {
      "pending": 0,
      "active": 0,
      "failed": 0,
      "revoking": 0,
      "revoked": 0
    }
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`collection-get-vault.response.200.data`; object, required)
  - `collectionId` (`collection-get-vault.response.200.data.collectionId`; string, required)
    - format `uuid`
  - `status` (`collection-get-vault.response.200.data.status`; string, required)
    - one of `"not_vaulted"`, `"enabling"`, `"active"`, `"failed"`
  - `chainId` (`collection-get-vault.response.200.data.chainId`; integer, required, nullable)
  - `chainName` (`collection-get-vault.response.200.data.chainName`; string, required, nullable)
  - `tokenModuleAddress` (`collection-get-vault.response.200.data.tokenModuleAddress`; string, required, nullable)
  - `tokenId` (`collection-get-vault.response.200.data.tokenId`; string, required, nullable)
  - `initializeTransactionHash` (`collection-get-vault.response.200.data.initializeTransactionHash`; string, required, nullable)
  - `explorerUrl` (`collection-get-vault.response.200.data.explorerUrl`; string, required, nullable)
    - format `uri`
  - `lastError` (`collection-get-vault.response.200.data.lastError`; string, required, nullable)
  - `enabledAt` (`collection-get-vault.response.200.data.enabledAt`; string, required, nullable)
    - format `date-time`
  - `activatedAt` (`collection-get-vault.response.200.data.activatedAt`; string, required, nullable)
    - format `date-time`
  - `passes` (`collection-get-vault.response.200.data.passes`; object, required)
    - `pending` (`collection-get-vault.response.200.data.passes.pending`; integer, required)
      - min 0
    - `active` (`collection-get-vault.response.200.data.passes.active`; integer, required)
      - min 0
    - `failed` (`collection-get-vault.response.200.data.passes.failed`; integer, required)
      - min 0
    - `revoking` (`collection-get-vault.response.200.data.passes.revoking`; integer, required)
      - min 0
    - `revoked` (`collection-get-vault.response.200.data.passes.revoked`; integer, required)
      - min 0
- `meta` (`collection-get-vault.response.200.meta`; object, optional)
  - `timestamp` (`collection-get-vault.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`collection-get-vault.response.400.error`; object, required)
  - `code` (`collection-get-vault.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-get-vault.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`collection-get-vault.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-get-vault.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`collection-get-vault.response.401.error`; object, required)
  - `code` (`collection-get-vault.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-get-vault.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`collection-get-vault.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-get-vault.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`collection-get-vault.response.403.error`; object, required)
  - `code` (`collection-get-vault.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-get-vault.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`collection-get-vault.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-get-vault.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`collection-get-vault.response.404.error`; object, required)
  - `code` (`collection-get-vault.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-get-vault.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`collection-get-vault.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-get-vault.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`collection-get-vault.response.409.error`; object, required)
  - `code` (`collection-get-vault.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-get-vault.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`collection-get-vault.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-get-vault.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`collection-get-vault.response.500.error`; object, required)
  - `code` (`collection-get-vault.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-get-vault.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`collection-get-vault.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-get-vault.response.500.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/collection-get-vault/index.md