---
title: "List collection documents"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-v2-0/versions/de89c41a-3213-4ea1-ba03-774a702c2f4a/operations/listDocuments"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-v2-0/versions/de89c41a-3213-4ea1-ba03-774a702c2f4a.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

- `sort` (string, optional) - Sorts a collection of documents. The sort parameter is only applied for 'application/json' content-type. Supported sort attributes are: - created_at - updated_at - slug - title
- `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` (object, optional) - Filter documents returned in the response.

## Header parameters

- `Accept` (string, optional)

## Responses

- `200` - Documents in the collection
- `400` - Bad Request
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal DocumentHub admin Api v2
  version: 0.0.2
servers:
  - url: http://documenthub.documenthub.svc.cluster.local:4400/v2
    description: Konnect cluster
paths:
  /collections/{collectionId}/documents:
    parameters:
      - $ref: "#/components/parameters/collectionId"
    get:
      operationId: listDocuments
      summary: List collection documents
      description: List documents in a collection
      parameters:
        - name: Accept
          in: header
          schema:
            $ref: "#/components/schemas/DocumentContentTypeEnum"
        - $ref: "#/components/parameters/SortDocuments"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - name: filter
          in: query
          description: |
            Filter documents returned in the response.
          required: false
          schema:
            type: object
            properties:
              id:
                $ref: "#/components/schemas/UuidFieldFilter"
              slug:
                $ref: "#/components/schemas/StringFieldFilter"
              title:
                $ref: "#/components/schemas/StringFieldFilter"
              created_at:
                $ref: "#/components/schemas/DateTimeFieldFilter"
              updated_at:
                $ref: "#/components/schemas/DateTimeFieldFilter"
              metadata:
                $ref: "#/components/schemas/StringFieldFilter"
              status:
                $ref: "#/components/schemas/PublishStatus"
          style: deepObject
      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"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Documents
security:
  - konnectAccessToken: []
components:
  parameters:
    collectionId:
      name: collectionId
      in: path
      required: true
      description: Targeted collection
      example: bb84c46a-432d-4314-81e4-478614a52dcb
      schema:
        type: string
        format: uuid
    SortDocuments:
      name: sort
      description: |
        Sorts a collection of documents. 
        The sort parameter is only applied for 'application/json' content-type.
        Supported sort attributes are:
          - created_at
          - updated_at
          - slug
          - title
      in: query
      required: false
      schema:
        type: string
    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:
    DocumentContentTypeEnum:
      type: string
      default: application/json
      enum:
        - application/json
        - application/vnd.konnect.document-tree+json
    UuidFieldFilter:
      description: Filters on the given UUID field value by exact match.
      oneOf:
        - $ref: "#/components/schemas/StringFieldEqualsFilter"
        - $ref: "#/components/schemas/StringFieldOEQFilter"
        - $ref: "#/components/schemas/StringFieldNEQFilter"
      title: UuidFieldFilter
      x-examples:
        example-1: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-2:
          eq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-3:
          oeq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-4:
          neq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
    StringFieldFilter:
      description: Filters on the given string field value by either exact or fuzzy match.
      oneOf:
        - $ref: "#/components/schemas/StringFieldEqualsFilter"
        - $ref: "#/components/schemas/StringFieldContainsFilter"
        - $ref: "#/components/schemas/StringFieldOContainsFilter"
        - $ref: "#/components/schemas/StringFieldOEQFilter"
        - $ref: "#/components/schemas/StringFieldNEQFilter"
      title: StringFieldFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
        example-3:
          contains: some-value
        example-4:
          ocontains: some-potential,value
        example-5:
          oeq: some-potential,value
        example-6:
          neq: not-this-value
    DateTimeFieldFilter:
      description: Filters on the given datetime (RFC-3339) field value.
      oneOf:
        - type: string
          title: DateTimeFieldImplicitEqualsFilter
          format: date-time
          description: Value strictly equals given RFC-3339 formatted timestamp in UTC
          example: 2022-03-30T07:20:50Z
        - type: object
          title: DateTimeFieldEqualsFilter
          additionalProperties: false
          properties:
            eq:
              description: Value strictly equals given RFC-3339 formatted timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - eq
        - type: object
          title: DateTimeFieldLTFilter
          additionalProperties: false
          properties:
            lt:
              description: Value is less than the given RFC-3339 formatted timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - lt
        - type: object
          title: DateTimeFieldLTEFilter
          additionalProperties: false
          properties:
            lte:
              description: Value is less than or equal to the given RFC-3339 formatted
                timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - lte
        - type: object
          title: DateTimeFieldGTFilter
          additionalProperties: false
          properties:
            gt:
              description: Value is greater than the given RFC-3339 formatted timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - gt
        - type: object
          title: DateTimeFieldGTEFilter
          additionalProperties: false
          properties:
            gte:
              description: Value is greater than or equal to the given RFC-3339 formatted
                timestamp in UTC
              type: string
              format: date-time
              example: 2022-03-30T07:20:50Z
          required:
            - gte
      title: DateTimeFieldFilter
      x-examples:
        datetime_field_1: 2022-03-30T07:20:50Z
        datetime_field_2:
          eq: 2022-03-30T07:20:50Z
        datetime_field_3:
          lt: 2022-03-30T07:20:50Z
        datetime_field_4:
          lte: 2022-03-30T07:20:50Z
        datetime_field_5:
          gt: 2022-03-30T07:20:50Z
        datetime_field_6:
          gte: 2022-03-30T07:20:50Z
    PublishStatus:
      description: document publish status. Default to published.
      type: string
      enum:
        - published
        - unpublished
    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
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      oneOf:
        - type: string
        - type: object
          title: StringFieldEqualsComparison
          additionalProperties: false
          properties:
            eq:
              type: string
          required:
            - eq
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    StringFieldOEQFilter:
      description: Returns entities that exact match any of the comma-delimited
        phrases in the filter string.
      type: object
      properties:
        oeq:
          type: string
      additionalProperties: false
      required:
        - oeq
      title: StringFieldOEQFilter
      x-examples:
        example-1:
          oeq: some-value,some-other-value
    StringFieldNEQFilter:
      description: Filters on the given string field value by exact match inequality.
      type: object
      properties:
        neq:
          type: string
      additionalProperties: false
      required:
        - neq
      title: StringFieldNEQFilter
      x-examples:
        example-1:
          neq: not-this-value
    StringFieldContainsFilter:
      description: Filters on the given string field value by fuzzy match.
      type: object
      properties:
        contains:
          type: string
      additionalProperties: false
      required:
        - contains
      title: StringFieldContainsFilter
      x-examples:
        example-1:
          contains: some-value
    StringFieldOContainsFilter:
      description: Returns entities that fuzzy-match any of the comma-delimited
        phrases in the filter string.
      type: object
      properties:
        ocontains:
          type: string
      additionalProperties: false
      required:
        - ocontains
      title: StringFieldOContainsFilter
      x-examples:
        example-1:
          ocontains: this-value,or-that-value
    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
        filename:
          description: the filename of the document
          type: string
          example: myDocument.md
        status:
          $ref: "#/components/schemas/PublishStatus"
        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
        - filename
        - status
        - 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:
          type: string
        filename:
          type: string
          example: myDocument.md
        slug:
          description: document slug
          type: string
          example: path-for-seo
        metadata:
          $ref: "#/components/schemas/Metadata"
        status:
          $ref: "#/components/schemas/PublishStatus"
        children:
          description: children of the document
          type: array
          items:
            $ref: "#/components/schemas/DocumentTree"
          example:
            - id: d32d905a-ed33-46a3-a093-d8f536af9a8a
              title: Hello world
              filename: myDocument.md
              slug: hello-world
              status: published
              created_at: 2023-01-11T02:30:42.227Z
              updated_at: 2023-01-11T02:30:42.227Z
              metadata:
                author: John Doe
              children: []
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - title
        - filename
        - slug
        - metadata
        - children
        - status
        - created_at
        - updated_at
      title: DocumentTree
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    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:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
