pages

Queryin Content

List pages with optional filtering and search, for sitemaps, navigation and content management.

Arguments

Argument	Type	Description
`page`	`Int!`	Default `0`
`pageSize`	`Int!`	Default `50`
`version`	`ContentVersionType`
`types`	`[PageType!]`
`searchTerm`	`String`
`sort`	`PageSortOrderType`

Returns

Field	Type	Description
`results`	`[Page!]!`	List of pages returned in the result.
`total`	`Int!`	Total number of pages matching the query.

Example

query Pages(
  $page: Int!
  $pageSize: Int!
  $version: ContentVersionType
  $types: [PageType!]
  $searchTerm: String
  $sort: PageSortOrderType
) {
  pages(
    page: $page
    pageSize: $pageSize
    version: $version
    types: $types
    searchTerm: $searchTerm
    sort: $sort
  ) {
    results {
      id
      name
      heading
      path
    }
    total
  }
}

{
  "page": 1,
  "pageSize": 1,
  "version": "DRAFT",
  "types": [
    "CONTENT"
  ],
  "searchTerm": "Example",
  "sort": "NAME_ASCENDING"
}

{
  "data": {
    "pages": {
      "results": [
        {
          "id": "id-1",
          "name": "Example",
          "heading": "Example",
          "path": "/example"
        }
      ],
      "total": 1
    }
  }
}

The query selects the return type's fields two levels deep; pick the ones you need. The response shows its shape with placeholder values.