---
title: "ListPortalPagesResponse"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/schemas/ListPortalPagesResponse"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e.md

# ListPortalPagesResponse

Tree of custom pages in a portal. Not paginated.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    PortalPageInfo:
      description: Information about a page in a portal.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        slug:
          $ref: "#/components/schemas/PageSlug"
        title:
          $ref: "#/components/schemas/PageTitle"
        visibility:
          $ref: "#/components/schemas/VisibilityStatus"
        status:
          $ref: "#/components/schemas/PublishedStatus"
        description:
          $ref: "#/components/schemas/Description"
        parent_page_id:
          $ref: "#/components/schemas/ParentPageId"
        children:
          description: children of the page
          type: array
          items:
            $ref: "#/components/schemas/PortalPageInfo"
          example:
            - id: d32d905a-ed33-46a3-a093-d8f536af9a8a
              slug: hello-world
              title: Hello world
              visibility: public
              created_at: 2023-01-11T02:30:42.227Z
              updated_at: 2023-01-11T02:30:42.227Z
              status: unpublished
              parent_page_id: null
              children: []
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - slug
        - title
        - visibility
        - created_at
        - updated_at
        - status
        - parent_page_id
        - children
      title: PortalPageInfo
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    PageSlug:
      description: >
        The slug of a page in a portal, used to compute its full URL path within
        the portal hierarchy.

        When a page has a `parent_page_id`, its full path is built by joining
        the parent’s slug with its own.

        For example, if a parent page has the slug `slug1` and this page’s slug
        is `slug2`, the resulting path will be `/slug1/slug2`.

        This enables nested page structures like `/slug1/slug2/slug3`.
      type: string
      example: /my-page
      maxLength: 512
      title: PageSlug
    PageTitle:
      description: The title of a page in a portal.
      type: string
      example: My Page
      maxLength: 512
      title: PageTitle
    VisibilityStatus:
      description: Whether the resource is publicly accessible to non-authenticated users.
      type: string
      example: public
      enum:
        - public
        - private
      title: VisibilityStatus
    PublishedStatus:
      description: Whether the resource is visible on a given portal. Defaults to
        unpublished.
      type: string
      example: published
      enum:
        - published
        - unpublished
      title: PublishedStatus
    Description:
      type: string
      example: A custom page about developer portals
      maxLength: 160
      title: ResourceDescription
    ParentPageId:
      description: >
        Pages may be rendered as a tree of files.


        Specify the `id` of another page as the `parent_page_id` to add some
        hierarchy to your pages.
      type: string
      format: uuid
      example: null
      nullable: 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
    ListPortalPagesResponse:
      description: Tree of custom pages in a portal. Not paginated.
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/PortalPageInfo"
      example:
        data:
          - id: 437c7192-fea0-4f35-8478-c8d57783f8c1
            slug: /my-page
            title: My Page
            visibility: public
            status: unpublished
            description: A custom page
            created_at: 2021-01-01T00:00:00Z
            updated_at: 2021-01-01T00:00:00Z
            parent_page_id: null
            children: []
      additionalProperties: false
      required:
        - data
      title: ListPortalPagesResponse
```
