---
title: "ListDocumentsPortal"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-0/versions/e30c6169-1eab-485d-8526-f80b29f34b35/schemas/ListDocumentsPortal"
---

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

# ListDocumentsPortal

## 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
components:
  schemas:
    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
    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
    ListDocumentsPortal:
      type: object
      properties:
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
        data:
          type: array
          items:
            $ref: "#/components/schemas/DocumentItemPortal"
      additionalProperties: false
      required:
        - meta
        - data
```
