---
title: "List Sitemap Pages"
method: GET
path: "/{brand_id}/sitemap/pages"
tags: ["sitemap"]
---

# List Sitemap Pages

`GET /{brand_id}/sitemap/pages`

List pages discovered in the brand's sitemap with their title, description, depth, audit score, priority flag, and optimized-content flag.

Results come from the most recent completed crawl for the brand. Supports filtering by domain, URL depth, path prefix, priority flag, optimized-content flag, and a case-insensitive substring search across the page URL and title.

Results are paginated and ordered by depth then URL.

## Path parameters

- `brand_id` integer, required — The unique identifier for the brand.

## Query parameters

- `domain` string, nullable — Filter to a specific domain when the brand has multiple registered sites.
- `limit` integer — Maximum number of pages to return. Defaults to 100.
- `offset` integer — Number of pages to skip. Use with `limit` for pagination.
- `max_depth` integer, nullable — Maximum URL path depth to include. `0` returns root pages only.
- `path_prefix` string, nullable — Filter by segment-aligned URL path prefix. For example `/blog` matches `/blog` and `/blog/post` but not `/blogger`.
- `is_priority` boolean, nullable — Filter to (or exclude) pages flagged as priority for the brand.
- `has_optimized_content` boolean, nullable — Filter to (or exclude) pages with active AXP optimized content deployed.
- `search` string, nullable — Case-insensitive substring match against the page URL or title.

## Response `200`

Successful Response

- SitemapPagesResponse
  - `total` integer, required
  - `offset` integer
  - `limit` integer, nullable
  - `items` SitemapPageListing[], required
    - `id` integer, required — Unique page identifier.
    - `url` string, required — Full URL of the page.
    - `title` string, nullable, required — HTML title of the page.
    - `description` string, nullable, required — Meta description of the page.
    - `depth` integer, required — URL path depth (`0` = root).
    - `audit_score` integer, nullable, required — AI search readiness score (0-100).
    - `canonical_url` string, nullable, required — Canonical URL if different from the page's URL.
    - `is_priority` boolean, required — Whether this page matches a priority page or priority path override for the brand.
    - `has_optimized_content` boolean, required — Whether this page has active AXP optimized content deployed.
  - `domain` string, required — The domain these pages belong to.
  - `last_crawl_completed` string, date-time, nullable, required — When the most recent completed crawl finished.

## Other responses

- `404` — No completed sitemap crawl found for this brand.
- `422` — Validation Error

---

[API](https://skmtc.net/scrunch/apis/scrunch-data-api.md) · [All operations](https://skmtc.net/scrunch/apis/scrunch-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scrunch/scrunch-data-api/revisions/3e09c2a06458/schema)
