Skip to content

List entries

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

Needs the read scope.

Pages its answer: pass the cursor back for the next page, at most 100 items a page.

Filters: section (eq, in), tag (eq, in), published_at (gte, lte).

Sorts: position, published.

Searches title, subtitle, preview. An empty page with a cursor means nothing so far: only a null cursor ends a search. A searched page past the count budget comes back without its total and facets, which never means zero.

Call

  • Tool: list_entries
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
query object No
preview string No A token a seller made for the product’s page or one of its entries, which lists an unpublished product’s published entries.
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {
            "section": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string"
                    },
                    "in": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "minItems": 1,
                      "maxItems": 50
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            },
            "tag": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string"
                    },
                    "in": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "minItems": 1,
                      "maxItems": 50
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            },
            "published_at": {
              "type": "object",
              "properties": {
                "gte": {
                  "type": "string",
                  "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
                },
                "lte": {
                  "type": "string",
                  "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})(?:T(\\d{2}):(\\d{2})(?::(\\d{2})(?:\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
                }
              },
              "minProperties": 1,
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "position",
                "published"
              ]
            },
            "direction": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          "additionalProperties": false
        },
        "search": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "cursor": {
          "type": "string",
          "maxLength": 8192
        },
        "count": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "preview": {
      "description": "A token a seller made for the product's page or one of its entries, which lists an unpublished product's published entries.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
items array of object Yes
cursor string or null Yes
total number No
facets object No

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close