---
title: "Reads the home's, a product's, entry's or page's body, or the default layout its page shows in its place, where the customer may; one still uploading fails `conflict` on `status` (`pending`), so retry it shortly."
---

> 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 › body

`GET /v1/stores/{store}/body`

## Authentication

Requires one of the following:

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

## Path parameters

- `store` (`readBody.path.store`; string, required) — A hostname of the store.

## Query parameters

- `target` (`readBody.query.target`; any of, required)
  - any of: `object`, `object`
- `preview` (`readBody.query.preview`; string, optional) — A token a seller made for the target's page, which opens it unpublished with its staged body; a product's opens its published entries' bodies, gated as ever, and an entry's its product's live body, gated as ever.
  - minLength 1; maxLength 128
- `fallback` (`readBody.query.fallback`; boolean, optional) — Answers the target's default layout whatever its body, for a page that can show none of its own blocks.

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/customer/v1/stores/<store>/body?target=<target>';
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>/body?target=<target>"

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

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

print(response.text)
```

## Responses

### 200

Reads the home's, a product's, entry's or page's body, or the default layout its page shows in its place, where the customer may; one still uploading fails `conflict` on `status` (`pending`), so retry it shortly.

#### Example

```json
{
  "default": null,
  "content": null,
  "words": 0,
  "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"
    }
  ],
  "requires": {
    "kind": "everyone"
  },
  "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"
  }
}
```

Any of:

- `object`
- `object`
- `object`

### 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` (`readBody.response.default.type`; string, required)
  - format `uri`
- `title` (`readBody.response.default.title`; string, required)
- `status` (`readBody.response.default.status`; integer, required)
- `detail` (`readBody.response.default.detail`; string, required)
- `code` (`readBody.response.default.code`; string, optional)
- `context` (`readBody.response.default.context`; object, optional)
- `reached_core` (`readBody.response.default.reached_core`; boolean, optional)
- `core_answer` (`readBody.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/customer-api/reference/read-body/index.md
