---
title: "List Pages"
url: "https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99/operations/list-portal-pages"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99.md

# List Pages

`GET` `/api/v3/pages`

Operation ID: `list-portal-pages`

Returns a tree view of pages for the portal. Each page has a slug, title, and content. The full tree is returned in one response; this endpoint is not paginated. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.

## Query parameters

- `sort` (string, optional) - Sorts a collection of portal pages. Supported sort attributes are: - created_at - updated_at - slug - title - visibility
- `filter[title][eq]` (string, optional) - Filter by direct equality comparison of the title property with a supplied value.
- `filter[title]` (string, optional) - Filter by direct equality comparison (short-hand) of the title property with a supplied value.
- `filter[title][contains]` (string, optional) - Filter by contains comparison of the title property with a supplied substring
- `filter[slug][eq]` (string, optional) - Filter by direct equality comparison of the slug property with a supplied value.
- `filter[slug]` (string, optional) - Filter by direct equality comparison (short-hand) of the slug property with a supplied value.
- `filter[slug][contains]` (string, optional) - Filter by contains comparison of the slug property with a supplied substring
- `filter[visibility][eq]` (string, optional) - Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.
- `filter[visibility]` (string, optional) - Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.

## Responses

- `200` - Tree of portal pages for the portal

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal
  version: 3.3.1
paths:
  /api/v3/pages:
    get:
      operationId: list-portal-pages
      summary: List Pages
      description: Returns a tree view of pages for the portal. Each page has a slug,
        title, and content. The full tree is returned in one response; this
        endpoint is not paginated. Public pages will be returned for
        non-authenticated users, while both private and public pages will be
        returned for authenticated users.
      parameters:
        - $ref: "#/components/parameters/SortPortalPages"
        - $ref: "#/components/parameters/FilterByTitleEquality"
        - $ref: "#/components/parameters/FilterByTitleEqualityShort"
        - $ref: "#/components/parameters/FilterByTitleContains"
        - $ref: "#/components/parameters/FilterBySlugEquality"
        - $ref: "#/components/parameters/FilterBySlugEqualityShort"
        - $ref: "#/components/parameters/FilterBySlugContains"
        - $ref: "#/components/parameters/FilterByVisibilityEquality"
        - $ref: "#/components/parameters/FilterByVisibilityEqualityShort"
      responses:
        "200":
          $ref: "#/components/responses/ListPortalPagesResponse"
      security:
        - portalAccessToken: []
        - {}
      tags:
        - Content
security:
  - portalAccessToken: []
  - {}
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
    FilterByTitleEquality:
      name: filter[title][eq]
      description: Filter by direct equality comparison of the title property with a
        supplied value.
      in: query
      required: false
      schema:
        type: string
        example: Good Page
    FilterByTitleEqualityShort:
      name: filter[title]
      description: Filter by direct equality comparison (short-hand) of the title
        property with a supplied value.
      in: query
      required: false
      schema:
        type: string
        example: Good Page
    FilterByTitleContains:
      name: filter[title][contains]
      description: Filter by contains comparison of the title property with a supplied
        substring
      in: query
      required: false
      schema:
        type: string
        example: Good
    FilterBySlugEquality:
      name: filter[slug][eq]
      description: Filter by direct equality comparison of the slug property with a
        supplied value.
      in: query
      required: false
      schema:
        type: string
        example: good-page
    FilterBySlugEqualityShort:
      name: filter[slug]
      description: Filter by direct equality comparison (short-hand) of the slug
        property with a supplied value.
      in: query
      required: false
      schema:
        type: string
        example: good-page
    FilterBySlugContains:
      name: filter[slug][contains]
      description: Filter by contains comparison of the slug property with a supplied
        substring
      in: query
      required: false
      schema:
        type: string
        example: good
    FilterByVisibilityEquality:
      name: filter[visibility][eq]
      description: Filter by whether the pages returned are public or private. Private
        pages are only accessible to authenticated users. For authenticated
        users, results will include both public and private pages if not
        specified.
      in: query
      required: false
      schema:
        type: string
        example: public
        enum:
          - public
          - private
    FilterByVisibilityEqualityShort:
      name: filter[visibility]
      description: Filter (short-hand) by whether the pages returned are public or
        private. Private pages are only accessible to authenticated users. For
        authenticated users, results will include both public and private pages
        if not specified.
      in: query
      required: false
      schema:
        type: string
        example: private
        enum:
          - public
          - private
  responses:
    ListPortalPagesResponse:
      description: Tree of portal pages for the portal
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ListPortalPages"
          examples:
            ListPortalPageResponseExample1:
              value:
                data:
                  - id: 582b9327-3eba-4bfe-9438-6066840dbbca
                    title: Home
                    slug: /
                    visibility: public
                    description: Welcome page
                    parent_page_id: null
                    children: []
                    created_at: 2022-11-04T20:10:06.927Z
                    updated_at: 2022-11-04T20:10:06.927Z
  schemas:
    ListPortalPages:
      description: Tree of pages for the portal (nested `children`). Not paginated.
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/PortalPageInfo"
      additionalProperties: false
      required:
        - data
      title: ListPortalPages
    PortalPageInfo:
      description: A single page for the portal
      type: object
      properties:
        id:
          $ref: "#/components/schemas/PageId"
        slug:
          $ref: "#/components/schemas/PageSlug"
        title:
          $ref: "#/components/schemas/PageTitle"
        visibility:
          $ref: "#/components/schemas/Visibility"
        description:
          $ref: "#/components/schemas/Description"
        parent_page_id:
          $ref: "#/components/schemas/ParentPageId"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        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
              parent_page_id: null
              children: []
      additionalProperties: false
      required:
        - id
        - slug
        - title
        - visibility
        - created_at
        - updated_at
        - children
        - parent_page_id
      title: PortalPageInfo
    PageId:
      description: The unique identifier of the page
      type: string
      format: uuid
      example: 582b9327-3eba-4bfe-9438-6066840dbbca
      title: PageId
    PageSlug:
      description: The slug of the page.
      type: string
      example: /my-page
      title: PageSlug
    PageTitle:
      description: The title of the page
      type: string
      example: My Page
      title: PageTitle
    Visibility:
      description: Whether the page or snippet is public or private. Private pages and
        snippets are only accessible to authenticated users.
      type: string
      example: public
      enum:
        - public
        - private
      title: Resource Public Visibility
    Description:
      type: string
      example: A custom page about developer portals
      title: ResourceDescription
    ParentPageId:
      description: |
        Pages may be rendered as a tree of files.
      type: string
      format: uuid
      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
  securitySchemes:
    portalAccessToken:
      type: apiKey
      in: cookie
      name: portalaccesstoken
      description: >
        The Developer portal cookie is meant to be used by the Developer API to
        authenticate with.
```
