Skip to content
Navigation

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

GET
https://api.sherpo.io/customer/v1/stores/{store}/products/{product}/entries

Authorization

  • bearer
    optional
    HTTP
  • publishableKey
    optional
    API key in header

Path parameters

  • store
    string
    required

    A hostname of the store.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Query parameters

  • filter
    optional
    object

    filter[<field>]=<value> is an equality, filter[<field>][<op>]=<value> names the operator; in repeats the parameter.

  • sort
    optional
    position
    or
    published
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1
  • preview
    optional
    string

    A token a seller made for the product's page or one of its entries, which lists an unpublished product's published entries.

    maxLength: 128 · minLength: 1

Returns

200

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

JSON
  • items
    array of
    object
    required
    • has_quiz
      boolean
      required
    • has_certificate
      boolean
      required

      A certificate is earned on the entry's quiz.

    • quiz_score
      required

      The caller's best finished sitting on the entry's quiz; null signed out or with none.

      One of the following:

      • number
      • null
    • media
      object
      required
      • duration
        required

        The lesson video's length in seconds.

        One of the following:

        • number
        • null
      • slides
        required

        Pages across the lesson's slides; null without slides.

        One of the following:

        • number
        • null
      • files
        number
        required

        Deliverable files, links apart.

    • access
      string
      required
    • requires
      required

      One of the following:

      • object
      • object
      • object
    • opens_at
      required

      When its content opens to everyone it admits; null once open or without a release, and for a broken one, which stays locked.

      One of the following:

      • string
      • null
    • poster
      required

      One of the following:

      • object
      • null
    • files
      map of
      object
      required
    • completed_at
      required

      One of the following:

      • string
      • null
    • duration
      required

      The measured length in seconds of a podcast episode's own audio, told even when it is locked; null without one.

      One of the following:

      • number
      • null
    • words
      required

      How many words its live body shows, hidden blocks aside; told even when it is locked, null without a counted body.

      One of the following:

      • number
      • null
    • id
      string
      required
    • product_id
      string
      required
    • slug
      string
      required
    • path
      string
      required

      The storefront path.

    • url
      required

      The absolute URL on the store's verified hostname, or null before it has one.

      One of the following:

      • string
      • null
    • title
      string
      required
    • subtitle
      required

      One of the following:

      • string
      • null
    • section
      required

      One of the following:

      • string
      • null
    • author
      required

      Who signs it, or null when unsigned; a member with no name, or one central no longer holds, answers a null name.

      One of the following:

      • object
      • null
    • tags
      array of
      string
      required
    • preview
      required

      The teaser, in the rich text format as stored.

      One of the following:

      • string
      • null
    • position
      number
      required
    • published_at
      required

      One of the following:

      • string
      • null
    • unlisted_at
      required

      Set while it is out of the product's lists and indexes, though still reachable.

      One of the following:

      • string
      • null
    • created_at
      required

      One of the following:

      • string
      • null
    • updated_at
      required

      One of the following:

      • string
      • null
    • settings
      object
      required
      • ai_generated
        boolean
        required
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    number
  • facets
    optional
    map of
    map<number>
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close