---
title: "List Pages"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/operations/list-portal-pages"
---

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

# List Pages

`GET` `/portals/{portalId}/pages`

Operation ID: `list-portal-pages`

Returns the tree view of custom pages that have been created for this portal. The full tree is returned in one response; this endpoint is not paginated.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Query parameters

- `sort` (string, optional) - Sorts a collection of portal pages. Supported sort attributes are: - created_at - updated_at - slug - title - visibility
- `filter` (object, optional) - Filter pages returned in the response.

## Responses

- `200` - Tree of custom pages in a portal (nested `children`). Not paginated.
- `400` - Bad Request
- `401` - Unauthorized
- `404` - Not Found

## 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
paths:
  /portals/{portalId}/pages:
    get:
      operationId: list-portal-pages
      summary: List Pages
      description: Returns the tree view of custom pages that have been created for
        this portal. The full tree is returned in one response; this endpoint is
        not paginated.
      parameters:
        - $ref: "#/components/parameters/SortPortalPages"
        - $ref: "#/components/parameters/PortalId"
        - name: filter
          in: query
          description: Filter pages returned in the response.
          required: false
          schema:
            $ref: "#/components/schemas/PortalPagesFilterParameters"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/ListPortalPages"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                ListPortalPagesBadRequestExample1:
                  $ref: "#/components/examples/ListPortalPagesBadRequestExample1"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Pages
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    SortPortalPages:
      name: sort
      description: |
        Sorts a collection of portal pages. Supported sort attributes are:
          - created_at
          - updated_at
          - slug
          - title
          - visibility
      in: query
      required: false
      schema:
        type: string
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  schemas:
    PortalPagesFilterParameters:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UuidFieldFilter"
        slug:
          $ref: "#/components/schemas/StringFieldFilter"
        title:
          $ref: "#/components/schemas/StringFieldFilter"
        visibility:
          $ref: "#/components/schemas/StringFieldFilter"
        created_at:
          $ref: "#/components/schemas/DateTimeFieldFilter"
        updated_at:
          $ref: "#/components/schemas/DateTimeFieldFilter"
      additionalProperties: false
      title: PortalPagesFilterParameters
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UuidFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
      additionalProperties: false
      x-examples:
        example-1:
          oeq: some-value,some-other-value
          neq: not-this-value
        example-2:
          eq: some-value
    StringFieldFilter:
      oneOf:
        - title: Filter by operator
          description: "Filter using **one** of the following operators: `eq`, `oeq`,
            `neq`, `contains`, `ocontains`"
          x-examples:
            example-1:
              contains: some-value
              ocontains: this-value,or-that-value
              oeq: some-value,some-other-value
              neq: not-this-value
            example-2:
              eq: some-value
          properties:
            eq:
              description: The field exactly matches the provided value.
              type: string
              example: ?filter[field_name_here][eq]=foo
            contains:
              description: The field contains the provided value.
              type: string
              example: ?filter[field_name_here][contains]=foo
            ocontains:
              description: The field contains any of the provided values.
              type: string
              example: ?filter[field_name_here][ocontains]=foo,bar
            oeq:
              description: The field matches any of the provided values.
              type: string
              example: ?filter[field_name_here][oeq]=foo,bar
            neq:
              description: The field does not match the provided value.
              type: string
              example: ?filter[field_name_here][neq]=bar
          type: object
          additionalProperties: false
        - title: Filter by exact string match
          type: string
          description: The field exactly matches the provided value.
          example: ?filter[title]=foo
    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
    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
    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
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    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
    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
    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
    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
    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:
    ListPortalPages:
      description: Tree of custom pages in a portal (nested `children`). Not paginated.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ListPortalPagesResponse"
          examples:
            Example 1:
              $ref: "#/components/examples/ListPortalPagesExample1"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    ListPortalPagesBadRequestExample1:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: filter[my_attribute]
            rule: unknown_property
            reason: '"filter[my_attribute]" is not allowed'
            source: query
    ListPortalPagesExample1:
      value:
        data:
          - id: 8f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            slug: /
            title: Home
            visibility: public
            status: published
            description: A custom page
            created_at: 2022-02-07T17:46:57.52Z
            updated_at: 2022-10-08T17:00:00.52Z
            parent_page_id: null
            children: []
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
