---
title: "Get many documents"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-0/versions/e30c6169-1eab-485d-8526-f80b29f34b35/operations/getManyDocuments"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-0/versions/e30c6169-1eab-485d-8526-f80b29f34b35.md

# Get many documents

`GET` `/{resourceKind}/{resourceId}/documents`

Operation ID: `getManyDocuments`

Get many documents

## Path parameters

- `resourceKind` (string, required) - Kind of the Konnect resource
- `resourceId` (string, uuid, required) - Id of the Konnect resource

## 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.

## Header parameters

- `Accept` (string, optional)

## Responses

- `200` - Tree of documents
- `400` - Bad Request

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal DocumentHub Developer Api
  version: 0.0.1
servers:
  - url: http://documenthub.documenthub.svc.cluster.local:4400/developer/v0
    description: Konnect cluster
paths:
  /{resourceKind}/{resourceId}/documents:
    get:
      operationId: getManyDocuments
      summary: Get many documents
      description: Get many documents
      parameters:
        - name: Accept
          in: header
          schema:
            $ref: "#/components/schemas/DocumentContentTypeEnum"
        - $ref: "#/components/parameters/resourceKindParam"
        - $ref: "#/components/parameters/resourceId"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          description: Tree of documents
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListDocumentsPortal"
            application/vnd.konnect.document-tree+json:
              schema:
                $ref: "#/components/schemas/ListDocumentsTree"
            text/markdown:
              schema:
                description: the markdown content
                type: string
        "400":
          $ref: "#/components/responses/BadRequest"
      tags:
        - Customization
security:
  - bearerAuth: []
components:
  schemas:
    DocumentContentTypeEnum:
      type: string
      default: application/json
      enum:
        - application/json
        - application/vnd.konnect.document-tree+json
    ListDocumentsPortal:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/DocumentItemPortal"
      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
    DocumentItemPortal:
      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
      additionalProperties: false
      required:
        - id
        - parent_document_id
        - slug
        - title
      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
        meta:
          description: the metadata of the document
          type: object
          example:
            author: Jane Doe
            description: This is a description
            keywords: hello, world
        children:
          type: array
          items:
            $ref: "#/components/schemas/DocumentTree"
      required:
        - id
        - title
        - slug
        - meta
        - children
      title: DocumentTree
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    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
  parameters:
    resourceKindParam:
      name: resourceKind
      in: path
      required: true
      description: Kind of the Konnect resource
      example: services
      schema:
        type: string
        enum:
          - services
    resourceId:
      name: resourceId
      in: path
      required: true
      description: Id of the Konnect resource
      example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
      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
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
```
