---
title: "List vault passes"
---

> 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/passes`

## Path parameters

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

## Query parameters

- `status` (`collection-list-vault-passes.query.status`; string, optional)
  - one of `"pending"`, `"active"`, `"failed"`, `"revoking"`, `"revoked"`
- `limit` (`collection-list-vault-passes.query.limit`; integer, optional)
  - min 1; max 200; default `50`
- `offset` (`collection-list-vault-passes.query.offset`; integer, optional)
  - min 0; default `0`

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/entities/<entityId>/collections/<id>/vault/passes';
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/passes"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "passes": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "recipientUserId": "string",
        "recipientName": "string",
        "walletAddress": "string",
        "status": "pending",
        "transactionHash": "string",
        "revokeTransactionHash": "string",
        "explorerUrl": "http://example.com",
        "lastError": "string",
        "grantedAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "total": 0
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`collection-list-vault-passes.response.200.data`; object, required)
  - `passes` (`collection-list-vault-passes.response.200.data.passes`; array<object>, required)
    - `id` (`collection-list-vault-passes.response.200.data.passes.id`; string, required)
      - format `uuid`
    - `recipientUserId` (`collection-list-vault-passes.response.200.data.passes.recipientUserId`; string, required)
    - `recipientName` (`collection-list-vault-passes.response.200.data.passes.recipientName`; string, required, nullable)
    - `walletAddress` (`collection-list-vault-passes.response.200.data.passes.walletAddress`; string, required, nullable)
    - `status` (`collection-list-vault-passes.response.200.data.passes.status`; string, required)
      - one of `"pending"`, `"active"`, `"failed"`, `"revoking"`, `"revoked"`
    - `transactionHash` (`collection-list-vault-passes.response.200.data.passes.transactionHash`; string, required, nullable)
    - `revokeTransactionHash` (`collection-list-vault-passes.response.200.data.passes.revokeTransactionHash`; string, required, nullable)
    - `explorerUrl` (`collection-list-vault-passes.response.200.data.passes.explorerUrl`; string, required, nullable)
      - format `uri`
    - `lastError` (`collection-list-vault-passes.response.200.data.passes.lastError`; string, required, nullable)
    - `grantedAt` (`collection-list-vault-passes.response.200.data.passes.grantedAt`; string, required)
      - format `date-time`
    - `updatedAt` (`collection-list-vault-passes.response.200.data.passes.updatedAt`; string, required)
      - format `date-time`
  - `total` (`collection-list-vault-passes.response.200.data.total`; integer, required)
    - min 0
- `meta` (`collection-list-vault-passes.response.200.meta`; object, optional)
  - `timestamp` (`collection-list-vault-passes.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-list-vault-passes.response.400.error`; object, required)
  - `code` (`collection-list-vault-passes.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-list-vault-passes.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`collection-list-vault-passes.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-list-vault-passes.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-list-vault-passes.response.401.error`; object, required)
  - `code` (`collection-list-vault-passes.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-list-vault-passes.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`collection-list-vault-passes.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-list-vault-passes.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-list-vault-passes.response.403.error`; object, required)
  - `code` (`collection-list-vault-passes.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-list-vault-passes.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`collection-list-vault-passes.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-list-vault-passes.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-list-vault-passes.response.404.error`; object, required)
  - `code` (`collection-list-vault-passes.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-list-vault-passes.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`collection-list-vault-passes.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-list-vault-passes.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-list-vault-passes.response.409.error`; object, required)
  - `code` (`collection-list-vault-passes.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-list-vault-passes.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`collection-list-vault-passes.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-list-vault-passes.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-list-vault-passes.response.500.error`; object, required)
  - `code` (`collection-list-vault-passes.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`collection-list-vault-passes.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`collection-list-vault-passes.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`collection-list-vault-passes.response.500.error.traceId`; string, optional) — Unique ID for log correlation


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