---
title: "List collection access requests"
---

> 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}/vault/access-requests`

## Path parameters

- `entityId` (`startup-list-collection-access-requests.path.entityId`; string, required)
  - format `uuid`

## Query parameters

- `status` (`startup-list-collection-access-requests.query.status`; string, optional)
  - one of `"pending"`, `"approved"`, `"rejected"`, `"cancelled"`
- `limit` (`startup-list-collection-access-requests.query.limit`; number, optional)
  - min 1; max 100; default `50`
- `offset` (`startup-list-collection-access-requests.query.offset`; number, optional)
  - min 0; default `0`

## Code samples

### cURL

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

### TypeScript

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

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
      "requesterUserId": "string",
      "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509",
      "status": "pending",
      "tokenNetwork": "base-mainnet",
      "tokenGrantStatus": "not_requested",
      "tokenGrantJobId": "string",
      "tokenGrantAttempts": 0,
      "tokenGrantLastError": "string",
      "tokenGrantLastAttemptAt": "2019-08-24T14:15:22Z",
      "tokenGrantCompletedAt": "2019-08-24T14:15:22Z",
      "requestNote": "string",
      "reviewNotes": "string",
      "reviewedBy": "string",
      "reviewedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "requester": {
        "id": "string",
        "name": "string",
        "email": "user@example.com",
        "company": "string",
        "title": "string",
        "avatar": "string"
      },
      "requesterEntity": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "slug": "string",
        "logoUrl": "string"
      },
      "collection": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "description": "string"
      }
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true,
    "page": 0,
    "totalPages": 0
  }
}
```

- `data` (`startup-list-collection-access-requests.response.200.data`; array<object>, required)
  - `id` (`startup-list-collection-access-requests.response.200.data.id`; string, required)
    - format `uuid`
  - `collectionId` (`startup-list-collection-access-requests.response.200.data.collectionId`; string, required)
    - format `uuid`
  - `requesterUserId` (`startup-list-collection-access-requests.response.200.data.requesterUserId`; string, required)
  - `requesterEntityId` (`startup-list-collection-access-requests.response.200.data.requesterEntityId`; string, required, nullable)
    - format `uuid`
  - `status` (`startup-list-collection-access-requests.response.200.data.status`; string, required)
    - one of `"pending"`, `"approved"`, `"rejected"`, `"cancelled"`
  - `tokenNetwork` (`startup-list-collection-access-requests.response.200.data.tokenNetwork`; string, required)
    - one of `"base-mainnet"`
  - `tokenGrantStatus` (`startup-list-collection-access-requests.response.200.data.tokenGrantStatus`; string, required)
    - one of `"not_requested"`, `"pending"`, `"granted"`, `"revoked"`, `"failed"`
  - `tokenGrantJobId` (`startup-list-collection-access-requests.response.200.data.tokenGrantJobId`; string, required, nullable)
  - `tokenGrantAttempts` (`startup-list-collection-access-requests.response.200.data.tokenGrantAttempts`; integer, required)
    - min 0
  - `tokenGrantLastError` (`startup-list-collection-access-requests.response.200.data.tokenGrantLastError`; string, required, nullable)
  - `tokenGrantLastAttemptAt` (`startup-list-collection-access-requests.response.200.data.tokenGrantLastAttemptAt`; string, required, nullable)
    - format `date-time`
  - `tokenGrantCompletedAt` (`startup-list-collection-access-requests.response.200.data.tokenGrantCompletedAt`; string, required, nullable)
    - format `date-time`
  - `requestNote` (`startup-list-collection-access-requests.response.200.data.requestNote`; string, required, nullable)
  - `reviewNotes` (`startup-list-collection-access-requests.response.200.data.reviewNotes`; string, required, nullable)
  - `reviewedBy` (`startup-list-collection-access-requests.response.200.data.reviewedBy`; string, required, nullable)
  - `reviewedAt` (`startup-list-collection-access-requests.response.200.data.reviewedAt`; string, required, nullable)
    - format `date-time`
  - `createdAt` (`startup-list-collection-access-requests.response.200.data.createdAt`; string, required)
    - format `date-time`
  - `updatedAt` (`startup-list-collection-access-requests.response.200.data.updatedAt`; string, required)
    - format `date-time`
  - `requester` (`startup-list-collection-access-requests.response.200.data.requester`; object, required)
    - `id` (`startup-list-collection-access-requests.response.200.data.requester.id`; string, required)
    - `name` (`startup-list-collection-access-requests.response.200.data.requester.name`; string, required)
    - `email` (`startup-list-collection-access-requests.response.200.data.requester.email`; string, required)
      - format `email`
    - `company` (`startup-list-collection-access-requests.response.200.data.requester.company`; string, required, nullable)
    - `title` (`startup-list-collection-access-requests.response.200.data.requester.title`; string, required, nullable)
    - `avatar` (`startup-list-collection-access-requests.response.200.data.requester.avatar`; string, required, nullable)
  - `requesterEntity` (`startup-list-collection-access-requests.response.200.data.requesterEntity`; object, required, nullable)
    - `id` (`startup-list-collection-access-requests.response.200.data.requesterEntity.id`; string, required)
      - format `uuid`
    - `name` (`startup-list-collection-access-requests.response.200.data.requesterEntity.name`; string, required)
    - `slug` (`startup-list-collection-access-requests.response.200.data.requesterEntity.slug`; string, required, nullable)
    - `logoUrl` (`startup-list-collection-access-requests.response.200.data.requesterEntity.logoUrl`; string, required, nullable)
  - `collection` (`startup-list-collection-access-requests.response.200.data.collection`; object, required)
    - `id` (`startup-list-collection-access-requests.response.200.data.collection.id`; string, required)
      - format `uuid`
    - `name` (`startup-list-collection-access-requests.response.200.data.collection.name`; string, required)
    - `description` (`startup-list-collection-access-requests.response.200.data.collection.description`; string, required, nullable)
- `meta` (`startup-list-collection-access-requests.response.200.meta`; object, required)
  - `total` (`startup-list-collection-access-requests.response.200.meta.total`; number, required) — Total number of items available
  - `limit` (`startup-list-collection-access-requests.response.200.meta.limit`; number, required) — Number of items per page
  - `offset` (`startup-list-collection-access-requests.response.200.meta.offset`; number, required) — Number of items skipped
  - `hasMore` (`startup-list-collection-access-requests.response.200.meta.hasMore`; boolean, required) — Whether more items are available
  - `page` (`startup-list-collection-access-requests.response.200.meta.page`; number, optional) — Current page number
  - `totalPages` (`startup-list-collection-access-requests.response.200.meta.totalPages`; number, optional) — Total number of pages

### 400

Default Response

#### Example

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

- `error` (`startup-list-collection-access-requests.response.400.error`; object, required)
  - `code` (`startup-list-collection-access-requests.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-list-collection-access-requests.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`startup-list-collection-access-requests.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-list-collection-access-requests.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` (`startup-list-collection-access-requests.response.401.error`; object, required)
  - `code` (`startup-list-collection-access-requests.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-list-collection-access-requests.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`startup-list-collection-access-requests.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-list-collection-access-requests.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` (`startup-list-collection-access-requests.response.403.error`; object, required)
  - `code` (`startup-list-collection-access-requests.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-list-collection-access-requests.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`startup-list-collection-access-requests.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-list-collection-access-requests.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` (`startup-list-collection-access-requests.response.404.error`; object, required)
  - `code` (`startup-list-collection-access-requests.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-list-collection-access-requests.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`startup-list-collection-access-requests.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-list-collection-access-requests.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` (`startup-list-collection-access-requests.response.409.error`; object, required)
  - `code` (`startup-list-collection-access-requests.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-list-collection-access-requests.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`startup-list-collection-access-requests.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-list-collection-access-requests.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` (`startup-list-collection-access-requests.response.500.error`; object, required)
  - `code` (`startup-list-collection-access-requests.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`startup-list-collection-access-requests.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`startup-list-collection-access-requests.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`startup-list-collection-access-requests.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

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

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


Source: https://docs.sureshake.com/reference/startup-list-collection-access-requests/index.md