pages
Search and paginate through pages
Authentication
Public Access: Accessible with the public API key
Query Structure
{
pages(
first: Int
after: String
last: Int
before: String
query: String
sortKey: PageSortKey
reverse: Boolean
) {
# PageConnection fields
}
}Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
| first | Int | No | Returns the first n elements. |
| after | String | No | Returns elements after cursor. |
| last | Int | No | Returns the last n elements. |
| before | String | No | Returns elements before cursor. |
| query | String | No | Search query string to filter pages by title or content. |
| sortKey | PageSortKey | No | The key to sort pages by. |
| reverse | Boolean | No | Reverse the order of the underlying list. |
Return Type
PageConnection - A connection object containing a list of pages with pagination information.
Example
query {
pages(first: 10, query: "about", sortKey: TITLE, reverse: false) {
edges {
node {
id
title
handle
body
}
cursor
}
pageInfo {
hasNextPage
hasPreviousPage
}
}
}