---
title: "Page"
method: GET
path: "/pages/{publicId}"
tags: ["Page"]
---

# Page

`GET /pages/{publicId}`

## Path parameters

- `publicId` string, required

## Query parameters

- `fields` string[]
- `filters` string[]

## Headers

- `Api-Version` 2, required
- `Api-Application` string, required
- `Api-Company` string, required
- `Api-Branding` string

## Response `200`

Success response

- object
  - `status` string, required
  - `type` string, required
  - `data` object, required
    - `publicId` string
    - `name` string
    - `applicationType` 'sheet' | 'card' | 'report'
    - `company` object
      - `publicId` string
    - `group` object, nullable
      - `publicId` string
    - `draft` object
      - `publicId` string
      - `page` object
        - `publicId` string
      - `title` string, nullable
      - `components` object[]
        - `publicId` string
        - `pageVersion` object
          - `publicId` string
        - `template` object
          - `publicId` string
        - `boundVersion` object, nullable
          - `template` object
            - `publicId` string
          - `publicId` string
          - `number` string
          - `mainPath` string
          - `notes` string, nullable
          - `publishedOn` string, date-time, nullable
          - `createdOn` string, date-time
          - `createdBy` object
            - `publicId` string
            - `name` string
        - `dimensions` union
          - object
            - `type` 'sheet', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
            - `mobileHeight` integer, nullable
            - `mobileOrder` integer, nullable
            - `mobileLeft` integer, nullable
            - `mobileCols` integer, nullable
          - object
            - `type` 'card', required
            - `height` integer, required
            - `order` integer, required
          - object
            - `type` 'report', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
          - object
            - `type` 'report-portrait', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
          - object
            - `type` 'report-landscape', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
        - `inputs` string
        - `pagePage` object, nullable
          - `publicId` string
          - `pageVersion` object
            - `publicId` string
          - `order` integer
      - `previewAgent` object, nullable
        - `publicId` string
      - `previewAsset` object, nullable
        - `publicId` string
      - `periodSpec` string, nullable
      - `periodSelectorEnabled` boolean
      - `defaultRefreshRate` integer, nullable
      - `createdOn` string, date-time
      - `createdBy` object, nullable
        - `publicId` string
        - `name` string
      - `updatedOn` string, date-time, nullable
      - `updatedBy` object, nullable
        - `publicId` string
        - `name` string
      - `pagePages` object[]
        - `publicId` string
        - `pageVersion` object
          - `publicId` string
        - `order` integer
      - `custom` object
    - `published` object
      - `publicId` string
      - `page` object
        - `publicId` string
      - `title` string, nullable
      - `components` object[]
        - `publicId` string
        - `pageVersion` object
          - `publicId` string
        - `template` object
          - `publicId` string
        - `boundVersion` object, nullable
          - `template` object
            - `publicId` string
          - `publicId` string
          - `number` string
          - `mainPath` string
          - `notes` string, nullable
          - `publishedOn` string, date-time, nullable
          - `createdOn` string, date-time
          - `createdBy` object
            - `publicId` string
            - `name` string
        - `dimensions` union
          - object
            - `type` 'sheet', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
            - `mobileHeight` integer, nullable
            - `mobileOrder` integer, nullable
            - `mobileLeft` integer, nullable
            - `mobileCols` integer, nullable
          - object
            - `type` 'card', required
            - `height` integer, required
            - `order` integer, required
          - object
            - `type` 'report', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
          - object
            - `type` 'report-portrait', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
          - object
            - `type` 'report-landscape', required
            - `left` integer, required
            - `top` integer, required
            - `cols` integer, required
            - `rows` integer, required
        - `inputs` string
        - `pagePage` object, nullable
          - `publicId` string
          - `pageVersion` object
          - `order` integer
      - `previewAgent` object, nullable
        - `publicId` string
      - `previewAsset` object, nullable
        - `publicId` string
      - `periodSpec` string, nullable
      - `periodSelectorEnabled` boolean
      - `defaultRefreshRate` integer, nullable
      - `createdOn` string, date-time
      - `createdBy` object, nullable
        - `publicId` string
        - `name` string
      - `updatedOn` string, date-time, nullable
      - `updatedBy` object, nullable
        - `publicId` string
        - `name` string
      - `pagePages` object[]
        - `publicId` string
        - `pageVersion` object
        - `order` integer
      - `custom` object
    - `default` boolean
    - `static` boolean
    - `orientation` 'portrait' | 'landscape', nullable
    - `labels` object[]
      - `color` string
      - `name` string
      - `publicId` string
      - `company` object
        - `publicId` string
    - `custom` object

## Other responses

- `4XX` — 4XX error response

---

[API](https://skmtc.net/ixon/apis/ixon-api.md) · [All operations](https://skmtc.net/ixon/apis/ixon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ixon/ixon-api/versions/7875dc33d41f/schema)