---
title: "Reads one custom page, its body too when asked."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo customer API › page

`GET /v1/stores/{store}/pages/{page}`

## Authentication

Requires one of the following:

- `bearer`, http, header `Authorization`, scopes: `read`
- `publishableKey`, apiKey, in header, header `Publishable-Key`

## Path parameters

- `store` (`getPage.path.store`; string, required) — A hostname of the store.
- `page` (`getPage.path.page`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

- `preview` (`getPage.query.preview`; string, optional)
  - minLength 1; maxLength 128
- `include` (`getPage.query.include`; array<string>, optional) — What else the read answers: `body` reads the body whole, as `readBody` does, and fails the read where `readBody` would.

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/customer/v1/stores/<store>/pages/<page>' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/customer/v1/stores/<store>/pages/<page>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/customer/v1/stores/<store>/pages/<page>"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Reads one custom page, its body too when asked.

#### Example

```json
{
  "files": {
    "property1": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    },
    "property2": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    }
  },
  "maps": [
    {
      "latitude": 0,
      "longitude": 0,
      "light": {
        "url": "string",
        "width": 0,
        "height": 0,
        "resized": [
          {
            "width": 1,
            "avif": "string",
            "webp": "string"
          }
        ]
      },
      "dark": {
        "url": "string",
        "width": 0,
        "height": 0,
        "resized": [
          {
            "width": 1,
            "avif": "string",
            "webp": "string"
          }
        ]
      },
      "attribution": "string",
      "attribution_url": "string"
    }
  ],
  "body": {
    "default": {
      "template": "string"
    },
    "attachment": {
      "id": "string"
    },
    "mime": "string",
    "access": "string",
    "requires": {
      "kind": "everyone"
    },
    "content": "string",
    "words": null
  },
  "attachments": [
    {
      "tracks": [
        {
          "id": "string",
          "label": "string",
          "language": "string",
          "generated": true
        }
      ],
      "outputs": [
        "string"
      ],
      "access": "string",
      "id": "string",
      "role": "string",
      "delivery": "string",
      "preview_only": true,
      "from_body": true,
      "position": 0,
      "asset": {
        "id": "string",
        "name": "string",
        "title": "string",
        "ext": "string",
        "description": "string",
        "mime": "string",
        "bytes": 0,
        "enforcement": "string",
        "locator": "string",
        "metadata": {
          "width": 0,
          "height": 0,
          "duration": 0,
          "pages": 0
        },
        "status": "string"
      }
    }
  ],
  "access": "string",
  "id": "string",
  "slug": "string",
  "path": "string",
  "url": "string",
  "title": "string",
  "description": "string",
  "menu_position": 0,
  "published_at": "string",
  "created_at": "string",
  "updated_at": "string",
  "settings": {
    "storefront": {
      "no_index": true
    }
  }
}
```

- `files` (`getPage.response.200.files`; map<object>, required)
- `maps` (`getPage.response.200.maps`; array<object>, required) — The maps the body's map blocks show, matched to a block by `latitude` and `longitude`; none while the body is kept from the reader.
  - `latitude` (`getPage.response.200.maps.latitude`; number, required)
  - `longitude` (`getPage.response.200.maps.longitude`; number, required)
  - `light` (`getPage.response.200.maps.light`; object, required) — For a light page.
    - `url` (`getPage.response.200.maps.light.url`; string, required) — A lasting URL to the image.
    - `width` (`getPage.response.200.maps.light.width`; number, required) — Its size in pixels.
    - `height` (`getPage.response.200.maps.light.height`; number, required)
    - `resized` (`getPage.response.200.maps.light.resized`; any of, optional) — Its smaller copies, narrowest first; null until made.
      - any of: `array<object>`, `null`
  - `dark` (`getPage.response.200.maps.dark`; object, required) — For a dark page.
    - `url` (`getPage.response.200.maps.dark.url`; string, required) — A lasting URL to the image.
    - `width` (`getPage.response.200.maps.dark.width`; number, required) — Its size in pixels.
    - `height` (`getPage.response.200.maps.dark.height`; number, required)
    - `resized` (`getPage.response.200.maps.dark.resized`; any of, optional) — Its smaller copies, narrowest first; null until made.
      - any of: `array<object>`, `null`
  - `attribution` (`getPage.response.200.maps.attribution`; string, required) — The credit shown over the map, linking `attribution_url`.
  - `attribution_url` (`getPage.response.200.maps.attribution_url`; string, required)
- `body` (`getPage.response.200.body`; any of, required)
  - any of: `object`, `object`, `null`
- `attachments` (`getPage.response.200.attachments`; array<object>, required)
  - `tracks` (`getPage.response.200.attachments.tracks`; array<object>, required)
    - `id` (`getPage.response.200.attachments.tracks.id`; string, required)
    - `label` (`getPage.response.200.attachments.tracks.label`; any of, required)
      - any of: `string`, `null`
    - `language` (`getPage.response.200.attachments.tracks.language`; any of, required)
      - any of: `string`, `null`
    - `generated` (`getPage.response.200.attachments.tracks.generated`; boolean, required) — Subtitles the store generated with AI from the video's audio.
  - `outputs` (`getPage.response.200.attachments.outputs`; array<string>, required) — The published AI outputs `getMediaOutputs` reads beside the video or audio file.
  - `access` (`getPage.response.200.attachments.access`; string, required)
  - `id` (`getPage.response.200.attachments.id`; string, required)
  - `role` (`getPage.response.200.attachments.role`; string, required)
  - `delivery` (`getPage.response.200.attachments.delivery`; string, required)
  - `preview_only` (`getPage.response.200.attachments.preview_only`; boolean, required)
  - `from_body` (`getPage.response.200.attachments.from_body`; boolean, required) — Named by its target's body text, rather than the target's own media (a lesson's video or slides).
  - `position` (`getPage.response.200.attachments.position`; number, required)
  - `asset` (`getPage.response.200.attachments.asset`; object, required)
    - `id` (`getPage.response.200.attachments.asset.id`; string, required)
    - `name` (`getPage.response.200.attachments.asset.name`; any of, required)
      - any of: `string`, `null`
    - `title` (`getPage.response.200.attachments.asset.title`; any of, required)
      - any of: `string`, `null`
    - `ext` (`getPage.response.200.attachments.asset.ext`; any of, required)
      - any of: `string`, `null`
    - `description` (`getPage.response.200.attachments.asset.description`; any of, required)
      - any of: `string`, `null`
    - `mime` (`getPage.response.200.attachments.asset.mime`; any of, required)
      - any of: `string`, `null`
    - `bytes` (`getPage.response.200.attachments.asset.bytes`; any of, required) — The file's size in bytes, null when it has none or is withheld.
      - any of: `number`, `null`
    - `enforcement` (`getPage.response.200.attachments.asset.enforcement`; string, required)
    - `locator` (`getPage.response.200.attachments.asset.locator`; any of, required)
      - any of: `string`, `null`
    - `metadata` (`getPage.response.200.attachments.asset.metadata`; object, required)
      - `width` (`getPage.response.200.attachments.asset.metadata.width`; any of, required)
        - any of: `number`, `null`
      - `height` (`getPage.response.200.attachments.asset.metadata.height`; any of, required)
        - any of: `number`, `null`
      - `duration` (`getPage.response.200.attachments.asset.metadata.duration`; any of, required)
        - any of: `number`, `null`
      - `pages` (`getPage.response.200.attachments.asset.metadata.pages`; any of, required)
        - any of: `number`, `null`
    - `status` (`getPage.response.200.attachments.asset.status`; string, required)
- `access` (`getPage.response.200.access`; string, required)
- `id` (`getPage.response.200.id`; string, required)
- `slug` (`getPage.response.200.slug`; string, required)
- `path` (`getPage.response.200.path`; string, required) — The storefront path.
- `url` (`getPage.response.200.url`; any of, required) — The absolute URL on the store's verified hostname, or null before it has one.
  - any of: `string`, `null`
- `title` (`getPage.response.200.title`; string, required)
- `description` (`getPage.response.200.description`; any of, required)
  - any of: `string`, `null`
- `menu_position` (`getPage.response.200.menu_position`; any of, required)
  - any of: `number`, `null`
- `published_at` (`getPage.response.200.published_at`; any of, required)
  - any of: `string`, `null`
- `created_at` (`getPage.response.200.created_at`; any of, required)
  - any of: `string`, `null`
- `updated_at` (`getPage.response.200.updated_at`; any of, required)
  - any of: `string`, `null`
- `settings` (`getPage.response.200.settings`; object, required)
  - `storefront` (`getPage.response.200.settings.storefront`; object, required)
    - `no_index` (`getPage.response.200.settings.storefront.no_index`; boolean, required)

### default

A problem; see https://api.sherpo.io/customer/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`getPage.response.default.type`; string, required)
  - format `uri`
- `title` (`getPage.response.default.title`; string, required)
- `status` (`getPage.response.default.status`; integer, required)
- `detail` (`getPage.response.default.detail`; string, required)
- `code` (`getPage.response.default.code`; string, optional)
- `context` (`getPage.response.default.context`; object, optional)
- `reached_core` (`getPage.response.default.reached_core`; boolean, optional)
- `core_answer` (`getPage.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/customer-api/reference/get-page/index.md
