---
title: "List Pages"
method: GET
path: "/v6/pages"
tags: ["page"]
---

# List Pages

`GET /v6/pages`

Returns a list of pages for a site.

## Query parameters

- `siteId` string, uuid, required
- `limit` number, double
- `startingAfter` string, uuid
- `pathPrefix` string
- `sortBy` 'title' | 'path' | 'description' | 'updatedAt' | 'createdAt'
- `sortDirection` 'asc' | 'desc'
- `includeOffline` 'true' | 'false'
- `locale` string
- `versionRef` 'ref:live' | 'ref:draft'

## Headers

- `x-api-key` string, required

## Response `200`

- ListPagesV2ResponseBodyDto
  - `object` 'list', required
  - `data` ListPagesV2ResponseBodyDtoDataItems[], required
    - `object` 'page', required
    - `id` string, uuid, required — The ID of the page.
    - `pathname` string, required — The page pathname.
    - `canonicalUrl` string, nullable, required — The canonical URL of the page.
    - `title` string, nullable, required — The page title.
    - `description` string, nullable, required — The page description.
    - `socialImageUrl` string, nullable, required — The social image URL of the page.
    - `sitemapPriority` number, double, nullable, required — The sitemap priority.
    - `sitemapFrequency` 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never', required — The sitemap update frequency.
    - `createdAt` string, date-time, nullable, required — The page creation date and time.
    - `updatedAt` string, date-time, nullable, required — The page last update date and time.
    - `publishedAt` string, date-time, nullable, required — The page publication date and time.
    - `isOnline` boolean, required — The flag that indicates whether the page is online.
    - `excludedFromSearchEngines` boolean, nullable, required — The flag that indicates whether the page is excluded from search.
    - `locale` string — The page locale. This defaults to the default locale of the parent site.
    - `localizations` ListPagesV2ResponseBodyDtoDataItemsLocalizationsItems[], required — The localizations of the page.
      - `locale` string — The locale of the localization.
      - `pathname` string, required — The pathname of the localization.
      - `id` string, uuid — The ID of the localization.
  - `hasMore` boolean, required — The flag that indicates whether there are more pages available.

## Other responses

- `403` — Access forbidden.

---

[API](https://skmtc.net/makeswift/apis/rest.md) · [All operations](https://skmtc.net/makeswift/apis/rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/makeswift/rest/revisions/9e0c72b4d151/schema)