---
title: "Get a channel layout"
method: GET
path: "/channels/{channel_id}/layouts/{layout_name}"
tags: ["Channel Layout Operations"]
---

# Get a channel layout

`GET /channels/{channel_id}/layouts/{layout_name}`

## Request

- Base URL: `https://developers.bloomreach.io/delivery/site/v2/documents`
- URL: `https://developers.bloomreach.io/delivery/site/v2/documents/channels/{channel_id}/layouts/{layout_name}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0/docs/channels/:channel_id/layouts/:layout_name/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `channel_id` string, required
- `layout_name` string, required

## Query parameters

- `resolved` boolean

## Response `200`

OK

- Layout
  - `name` string, required: identifying name of this layout within its channel
  - `label` string: default display label for this layout
  - `description` string: description for this layout
  - `parameters` object: a map of string parameters (names/values) for this layout
  - `type` 'abstract' | 'page' | 'xpage', required: page type defines the usage. Only abstract pages can be extended. Valid values: abstract, page, xpage
  - `extends` string: the name of the (abstract) page extended by this layout
  - `components` AbstractComponent[]: the components that are defined in the current layout
    - `name` string, required: identifying name of this component within its page
    - `label` string: default display label for this component
    - `description` string: description for this component
    - `parameters` object: a map of string parameters (names/values) for this component
    - `xtype` 'hst.vbox' | 'hst.unorderedlist' | 'hst.orderedlist' | 'hst.span' | 'hst.nomarkup': the layout used for rendering inner containers
    - `type` 'static' | 'managed', required: the type of this component

## Other responses

- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0.md) - [All operations](https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0/revisions/87bfc06578c2?raw)