---
title: "Polls the data for one page of a sitemap."
method: GET
path: "/sitemaps/{sitemapname}/{pageid}"
tags: ["sitemaps"]
---

# Polls the data for one page of a sitemap.

`GET /sitemaps/{sitemapname}/{pageid}`

## Request

- Base URL: `/rest` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/rest/sitemaps/{sitemapname}/{pageid}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/openhab/apis/openhab-rest-api/docs/sitemaps/:sitemapname/:pageid/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `sitemapname` string, required
- `pageid` string, required

## Query parameters

- `subscriptionid` string
- `includeHidden` boolean

## Headers

- `Accept-Language` string
- `X-Atmosphere-Transport` string

## Response `200`

OK

- PageDTO
  - `id` string
  - `title` string
  - `icon` string
  - `link` string
  - `parent` PageDTO (recursive)
  - `leaf` boolean
  - `timeout` boolean
  - `widgets` WidgetDTO[]
    - `widgetId` string
    - `type` string
    - `name` string
    - `visibility` boolean
    - `label` string
    - `labelSource` string
    - `icon` string
    - `staticIcon` boolean
    - `labelcolor` string
    - `valuecolor` string
    - `iconcolor` string
    - `pattern` string
    - `unit` string
    - `mappings` MappingDTO[]
      - `row` integer
      - `column` integer
      - `command` string
      - `releaseCommand` string
      - `label` string
      - `icon` string
    - `switchSupport` boolean
    - `releaseOnly` boolean
    - `sendFrequency` integer
    - `refresh` integer
    - `height` integer
    - `minValue` number
    - `maxValue` number
    - `step` number
    - `inputHint` string
    - `url` string
    - `encoding` string
    - `service` string
    - `period` string
    - `yAxisDecimalPattern` string
    - `legend` boolean
    - `forceAsItem` boolean
    - `row` integer
    - `column` integer
    - `command` string
    - `releaseCommand` string
    - `stateless` boolean
    - `state` string
    - `item` EnrichedItemDTO
      - `type` string
      - `name` string
      - `label` string
      - `category` string
      - `tags` string[]
      - `groupNames` string[]
      - `link` string
      - `state` string
      - `transformedState` string
      - `stateDescription` StateDescription
        - `minimum` number
        - `maximum` number
        - `step` number
        - `pattern` string
        - `readOnly` boolean
        - `options` StateOption[]
          - `value` string
          - `label` string
      - `unitSymbol` string
      - `commandDescription` CommandDescription
        - `commandOptions` CommandOption[]
          - `command` string
          - `label` string
      - `metadata` object
      - `editable` boolean
      - `groupType` string
    - `linkedPage` PageDTO (recursive)
    - `widgets` WidgetDTO[]

## Other responses

- `400`: Invalid subscription id has been provided.
- `404`: Sitemap with requested name does not exist or page does not exist, or page refers to a non-linkable widget

## Changes

- **2025-08-27** `79bdfda5456d`: 1 info
  - added the optional property `widgets/items/item/groupType` to the response with the `200` status
- **2025-08-05** `63300d04d170`: 1 warning
  - removed the optional property `widgets/items/item/groupType` from the response with the `200` status

[Operation history](https://skmtc.dev/openhab/apis/openhab-rest-api/changes/sitemaps/:sitemapname/:pageid/get.md)

---

[API](https://skmtc.dev/openhab/apis/openhab-rest-api.md) - [All operations](https://skmtc.dev/openhab/apis/openhab-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openhab/apis/openhab-rest-api/revisions/32c997172b27?raw)