---
title: "List API Package Documents"
method: GET
path: "/v3/api-packages/{packageId}/documents"
tags: ["API Package Documentation"]
---

# List API Package Documents

`GET /v3/api-packages/{packageId}/documents`

Returns a collection of all documents for an API package.

## Query parameters

- `filter` ApiDocumentFilterParameters
  - `status` StringFieldFilter — Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
    - `ocontains` string — The field contains any of the provided values.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.

## Response `200`

List of API Package documents

- object
  - `data` ApiDocumentSummaryWithChildren[], required
    - `id` string, uuid, required — The API document identifier.
    - `title` string, required — The title of the document. Used to populate the `<title>` tag for the page
    - `slug` string, required — The `slug` is used in generated URLs to provide human readable paths. Defaults to `slugify(title)`
    - `status` 'published' | 'unpublished', required — If `status=published` the document will be visible in your live portal
    - `parent_document_id` string, uuid, nullable, required — API Documents may be rendered as a tree of files. Specify the `id` of another API Document as the `parent_document_id` to add some heirarchy do your documents.
    - `created_at` string, date-time, required — An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity update date.
    - `children` ApiDocumentSummaryWithChildren[], required

## Other responses

- `400` — Bad Request
- `401` — ApiUnauthorized
- `403` — ApiForbidden
- `404` — Not Found

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/versions/f920f418f552/schema)