---
title: "List packages"
---

> 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 › directory

`GET /v2/directory/listings/{listingId}/packages`

## Path parameters

- `listingId` (`directory-list-packages.path.listingId`; string, required)
  - format `uuid`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/directory/listings/<listingId>/packages'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/directory/listings/<listingId>/packages';
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/directory/listings/<listingId>/packages"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
      "title": "string",
      "kind": "fund_overview",
      "description": "string",
      "status": "active",
      "requestable": true,
      "createdByUserId": "string",
      "collections": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "description": "string"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true,
    "page": 0,
    "totalPages": 0
  }
}
```

- `data` (`directory-list-packages.response.200.data`; array<object>, required)
  - `id` (`directory-list-packages.response.200.data.id`; string, required)
    - format `uuid`
  - `listingId` (`directory-list-packages.response.200.data.listingId`; string, required)
    - format `uuid`
  - `title` (`directory-list-packages.response.200.data.title`; string, required)
  - `kind` (`directory-list-packages.response.200.data.kind`; string, required)
    - one of `"fund_overview"`, `"track_record"`, `"investment_criteria"`, `"lp_materials"`, `"diligence"`, `"other"`
  - `description` (`directory-list-packages.response.200.data.description`; string, required, nullable)
  - `status` (`directory-list-packages.response.200.data.status`; string, required)
    - one of `"active"`, `"disabled"`
  - `requestable` (`directory-list-packages.response.200.data.requestable`; boolean, required)
  - `createdByUserId` (`directory-list-packages.response.200.data.createdByUserId`; string, required)
  - `collections` (`directory-list-packages.response.200.data.collections`; array<object>, required)
    - `id` (`directory-list-packages.response.200.data.collections.id`; string, required)
      - format `uuid`
    - `name` (`directory-list-packages.response.200.data.collections.name`; string, required)
    - `description` (`directory-list-packages.response.200.data.collections.description`; string, required, nullable)
  - `createdAt` (`directory-list-packages.response.200.data.createdAt`; string, required)
    - format `date-time`
  - `updatedAt` (`directory-list-packages.response.200.data.updatedAt`; string, required)
    - format `date-time`
- `meta` (`directory-list-packages.response.200.meta`; object, required)
  - `total` (`directory-list-packages.response.200.meta.total`; number, required) — Total number of items available
  - `limit` (`directory-list-packages.response.200.meta.limit`; number, required) — Number of items per page
  - `offset` (`directory-list-packages.response.200.meta.offset`; number, required) — Number of items skipped
  - `hasMore` (`directory-list-packages.response.200.meta.hasMore`; boolean, required) — Whether more items are available
  - `page` (`directory-list-packages.response.200.meta.page`; number, optional) — Current page number
  - `totalPages` (`directory-list-packages.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` (`directory-list-packages.response.400.error`; object, required)
  - `code` (`directory-list-packages.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-list-packages.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`directory-list-packages.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-list-packages.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` (`directory-list-packages.response.401.error`; object, required)
  - `code` (`directory-list-packages.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-list-packages.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`directory-list-packages.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-list-packages.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` (`directory-list-packages.response.403.error`; object, required)
  - `code` (`directory-list-packages.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-list-packages.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`directory-list-packages.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-list-packages.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` (`directory-list-packages.response.404.error`; object, required)
  - `code` (`directory-list-packages.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-list-packages.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`directory-list-packages.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-list-packages.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` (`directory-list-packages.response.409.error`; object, required)
  - `code` (`directory-list-packages.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-list-packages.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`directory-list-packages.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-list-packages.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

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

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

### 500

Default Response

#### Example

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

- `error` (`directory-list-packages.response.500.error`; object, required)
  - `code` (`directory-list-packages.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-list-packages.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`directory-list-packages.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-list-packages.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` (`directory-list-packages.response.503.error`; object, required)
  - `code` (`directory-list-packages.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-list-packages.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`directory-list-packages.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-list-packages.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/directory-list-packages/index.md