---
title: "Pages a product's entries with their access, a blog's or a podcast's newest first unless sorted."
---

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

`GET /v1/stores/{store}/products/{product}/entries`

## Authentication

Requires one of the following:

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

## Path parameters

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

## Query parameters

- `filter` (`listEntries.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listEntries.query.sort`; string, optional)
  - one of `"position"`, `"published"`
- `direction` (`listEntries.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listEntries.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listEntries.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listEntries.query.count`; boolean, optional)
- `search` (`listEntries.query.search`; string, optional)
  - minLength 1; maxLength 200
- `preview` (`listEntries.query.preview`; string, optional) — A token a seller made for the product's page or one of its entries, which lists an unpublished product's published entries.
  - minLength 1; maxLength 128

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

Pages a product's entries with their access, a blog's or a podcast's newest first unless sorted.

#### Example

```json
{
  "items": [
    {
      "has_quiz": true,
      "has_certificate": true,
      "quiz_score": 0,
      "media": {
        "duration": 0,
        "slides": 0,
        "files": 0,
        "links": 0
      },
      "access": "string",
      "requires": {
        "kind": "everyone"
      },
      "opens_at": "string",
      "poster": {
        "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"
        }
      },
      "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": {}
            }
          ],
          "video": {
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "outputs": [
              "string"
            ]
          },
          "audio": {
            "waveform": "string",
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "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": {}
            }
          ],
          "video": {
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "outputs": [
              "string"
            ]
          },
          "audio": {
            "waveform": "string",
            "attachment_id": "string",
            "tracks": [
              {}
            ],
            "outputs": [
              "string"
            ]
          }
        }
      },
      "completed_at": "string",
      "duration": 0,
      "words": 0,
      "id": "string",
      "product_id": "string",
      "slug": "string",
      "path": "string",
      "url": "string",
      "title": "string",
      "subtitle": "string",
      "section": "string",
      "author": {
        "kind": "string",
        "name": "string",
        "image": "string"
      },
      "tags": [
        "string"
      ],
      "preview": "string",
      "position": 0,
      "published_at": "string",
      "unlisted_at": "string",
      "created_at": "string",
      "updated_at": "string",
      "settings": {
        "ai_generated": true
      }
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listEntries.response.200.items`; array<object>, required)
  - `has_quiz` (`listEntries.response.200.items.has_quiz`; boolean, required)
  - `has_certificate` (`listEntries.response.200.items.has_certificate`; boolean, required) — A certificate is earned on the entry's quiz.
  - `quiz_score` (`listEntries.response.200.items.quiz_score`; any of, required) — The caller's best finished sitting on the entry's quiz; null signed out or with none.
    - any of: `number`, `null`
  - `media` (`listEntries.response.200.items.media`; object, required)
    - `duration` (`listEntries.response.200.items.media.duration`; any of, required) — The lesson video's length in seconds.
      - any of: `number`, `null`
    - `slides` (`listEntries.response.200.items.media.slides`; any of, required) — Pages across the lesson's slides; null without slides.
      - any of: `number`, `null`
    - `files` (`listEntries.response.200.items.media.files`; number, required) — Deliverable files, links apart.
    - `links` (`listEntries.response.200.items.media.links`; number, required)
  - `access` (`listEntries.response.200.items.access`; string, required)
  - `requires` (`listEntries.response.200.items.requires`; any of, required)
    - any of: `object`, `object`, `object`
  - `opens_at` (`listEntries.response.200.items.opens_at`; any of, required) — When its content opens to everyone it admits; null once open or without a release, and for a broken one, which stays locked.
    - any of: `string`, `null`
  - `poster` (`listEntries.response.200.items.poster`; any of, required)
    - any of: `object`, `null`
  - `files` (`listEntries.response.200.items.files`; map<object>, required)
  - `completed_at` (`listEntries.response.200.items.completed_at`; any of, required)
    - any of: `string`, `null`
  - `duration` (`listEntries.response.200.items.duration`; any of, required) — The measured length in seconds of a podcast episode's own audio, told even when it is locked; null without one.
    - any of: `number`, `null`
  - `words` (`listEntries.response.200.items.words`; any of, required) — How many words its live body shows, hidden blocks aside; told even when it is locked, null without a counted body.
    - any of: `number`, `null`
  - `id` (`listEntries.response.200.items.id`; string, required)
  - `product_id` (`listEntries.response.200.items.product_id`; string, required)
  - `slug` (`listEntries.response.200.items.slug`; string, required)
  - `path` (`listEntries.response.200.items.path`; string, required) — The storefront path.
  - `url` (`listEntries.response.200.items.url`; any of, required) — The absolute URL on the store's verified hostname, or null before it has one.
    - any of: `string`, `null`
  - `title` (`listEntries.response.200.items.title`; string, required)
  - `subtitle` (`listEntries.response.200.items.subtitle`; any of, required)
    - any of: `string`, `null`
  - `section` (`listEntries.response.200.items.section`; any of, required)
    - any of: `string`, `null`
  - `author` (`listEntries.response.200.items.author`; any of, required) — Who signs it, or null when unsigned; a member with no name, or one central no longer holds, answers a null name.
    - any of: `object`, `null`
  - `tags` (`listEntries.response.200.items.tags`; array<string>, required)
  - `preview` (`listEntries.response.200.items.preview`; any of, required) — The teaser, in the rich text format as stored.
    - any of: `string`, `null`
  - `position` (`listEntries.response.200.items.position`; number, required)
  - `published_at` (`listEntries.response.200.items.published_at`; any of, required)
    - any of: `string`, `null`
  - `unlisted_at` (`listEntries.response.200.items.unlisted_at`; any of, required) — Set while it is out of the product's lists and indexes, though still reachable.
    - any of: `string`, `null`
  - `created_at` (`listEntries.response.200.items.created_at`; any of, required)
    - any of: `string`, `null`
  - `updated_at` (`listEntries.response.200.items.updated_at`; any of, required)
    - any of: `string`, `null`
  - `settings` (`listEntries.response.200.items.settings`; object, required)
    - `ai_generated` (`listEntries.response.200.items.settings.ai_generated`; boolean, required)
- `cursor` (`listEntries.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listEntries.response.200.total`; number, optional)
- `facets` (`listEntries.response.200.facets`; map<map<number>>, optional)

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


Source: https://docs.sherpo.io/customer-api/reference/list-entries/index.md
