---
title: "Get the channel routes"
method: GET
path: "/channels/{channel_id}/routes"
tags: ["Channel Route Operations"]
---

# Get the channel routes

`GET /channels/{channel_id}/routes`

## Path parameters

- `channel_id` string, required

## Response `200`

OK

- Route[]
  - `name` string, required — the name (url path element) of the sitemap item. Each sitemap item name must be unique between its siblings.
  - `layout` string — the name of the (default) layout definition for rendering a url matching this sitemap item
  - `pageTitle` string — default page (header) title
  - `relativeContentPath` string — the (base) content path, relative to the channel (base) content path to use for rendering this sitemap item page, or any of its children
  - `referenceId` string — the (unique) reference id value can be used instead of the content path to create a direct link to this sitemap item
  - `parameters` object — a map of string parameters (names/values) for rendering this sitemap item page
  - `documentRequired` boolean — boolean value if the URL should have a (primary) document or folder item. Default false when missing. If the value is true and the URL does not map to a specific content item, the PageModelApi returns a 404 page.
  - `doctypePages` object — a more specialized page (name) mapping based on the matched document its type
  - `items` Route[] — a list of child sitemap items.

## Other responses

- `403` — Forbidden

---

[API](https://skmtc.net/bloomreach/apis/documents-delivery-api-2-0.md) · [All operations](https://skmtc.net/bloomreach/apis/documents-delivery-api-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bloomreach/documents-delivery-api-2-0/revisions/87bfc06578c2/schema)