---
title: "List collection documents"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-v2-0/versions/c8b8112f-9ae4-40f3-b57a-26511040e856/operations/listDocuments"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-v2-0/versions/c8b8112f-9ae4-40f3-b57a-26511040e856.md

# List collection documents

`GET` `/collections/{collectionId}/documents`

Operation ID: `listDocuments`

List documents in a collection

## Path parameters

- `collectionId` (string, uuid, required) - Targeted collection

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.
- `filter[field]` (string, optional) - A field to filter on. Supported fields: slug, metadata.

## Responses

- `200` - Documents in the collection
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal DocumentHub Developer Api v2
  version: 0.0.2
servers:
  - url: http://documenthub.documenthub.svc.cluster.local:4400/developer/v2
    description: Konnect cluster
paths:
  /collections/{collectionId}/documents:
    get:
      operationId: listDocuments
      summary: List collection documents
      description: List documents in a collection
      parameters:
        - $ref: "#/components/parameters/collectionId"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - name: filter[field]
          in: query
          description: |
            A field to filter on. Supported fields: slug, metadata.
          schema:
            type: string
            example: filter[name]=my-doc
      responses:
        "200":
          description: Documents in the collection
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDocuments"
            application/vnd.konnect.document-tree+json:
              schema:
                $ref: "#/components/schemas/ListDocumentsTree"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Documents
security:
  - portalAccessToken: []
components:
  parameters:
    collectionId:
      name: collectionId
      in: path
      required: true
      description: Targeted collection
      example: bb84c46a-432d-4314-81e4-478614a52dcb
      schema:
        type: string
        format: uuid
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
  schemas:
    ListDocuments:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/DocumentItem"
      additionalProperties: false
      required:
        - meta
        - data
    ListDocumentsTree:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/DocumentTree"
      required:
        - meta
        - data
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    DocumentItem:
      type: object
      properties:
        id:
          description: the id of the document
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        parent_document_id:
          description: the id of the parent document
          type: string
          format: uuid
          example: dd4e1b98-3629-4dd3-acc0-759a726ffee2
          nullable: true
        slug:
          description: the slug of the document
          type: string
          example: getting-started
        title:
          description: the title of the document
          type: string
          example: Getting Started
        metadata:
          $ref: "#/components/schemas/Metadata"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - parent_document_id
        - slug
        - title
        - metadata
        - created_at
        - updated_at
      title: Document item
    DocumentTree:
      description: a document tree
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        parent_document_id:
          type: string
          format: uuid
          example: dd4e1b98-3629-4dd3-acc0-759a726ffee2
          nullable: true
        title:
          description: the title of the document
          type: string
          example: Getting Started
        slug:
          description: the slug of the document
          type: string
          example: getting-started
        metadata:
          $ref: "#/components/schemas/Metadata"
        children:
          type: array
          items:
            $ref: "#/components/schemas/DocumentTree"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - title
        - slug
        - metadata
        - children
        - created_at
        - updated_at
      title: DocumentTree
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    Metadata:
      description: Contains key value pairs information about entity's metadata.
      type: object
      example:
        owner: John Appleseed
      additionalProperties: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    portalAccessToken:
      type: apiKey
      in: cookie
      name: portalaccesstoken
      description: >
        The Developer portal cookie is meant to be used by the Developer API to
        authenticate with.
```
