Skip to content
Navigation

Reads one entry with its access, its body too when asked.

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

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
  • entry
    string
    required
    minLength: 1

Query parameters

  • preview
    optional
    string

    A token a seller made for the entry's product's page, which opens a published entry of the product unpublished, gated as ever, or for the entry itself, which opens it unpublished too as its staged body shows it; with it, any entry it does not open is not_found preview.

    maxLength: 128 · minLength: 1
  • include
    optional
    array of
    string

    What else the read answers: body reads the body whole, as readBody does, and fails the read where readBody would.

Returns

200

Reads one entry with its access, its body too when asked.

JSON
  • files
    map of
    object
    required
  • maps
    array of
    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
      number
      required
    • longitude
      number
      required
    • light
      object
      required

      For a light page.

      • url
        string
        required

        A lasting URL to the image.

      • width
        number
        required

        Its size in pixels.

      • height
        number
        required
      • resized
        optional

        Its smaller copies, narrowest first; null until made.

        One of the following:

        • array<object>
        • null
    • dark
      object
      required

      For a dark page.

      • url
        string
        required

        A lasting URL to the image.

      • width
        number
        required

        Its size in pixels.

      • height
        number
        required
      • resized
        optional

        Its smaller copies, narrowest first; null until made.

        One of the following:

        • array<object>
        • null
    • attribution
      string
      required

      The credit shown over the map, linking attribution_url.

    • attribution_url
      string
      required
  • quiz
    required

    One of the following:

    • object
    • null
  • body
    required

    One of the following:

    • object
    • object
    • null
  • attachments
    array of
    object
    required
    • tracks
      array of
      object
      required
      • id
        string
        required
      • label
        required

        One of the following:

        • string
        • null
      • language
        required

        One of the following:

        • string
        • null
      • generated
        boolean
        required

        Subtitles the store generated with AI from the video's audio.

    • outputs
      array of
      string
      required

      The published AI outputs getMediaOutputs reads beside the video or audio file.

    • access
      string
      required
    • id
      string
      required
    • role
      string
      required
    • delivery
      string
      required
    • preview_only
      boolean
      required
    • 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
      number
      required
    • asset
      object
      required
      • id
        string
        required
      • name
        required

        One of the following:

        • string
        • null
      • title
        required

        One of the following:

        • string
        • null
      • ext
        required

        One of the following:

        • string
        • null
      • description
        required

        One of the following:

        • string
        • null
      • mime
        required

        One of the following:

        • string
        • null
      • bytes
        required

        The file's size in bytes, null when it has none or is withheld.

        One of the following:

        • number
        • null
      • enforcement
        string
        required
      • locator
        required

        One of the following:

        • string
        • null
      • metadata
        object
        required
        • width
          required

          One of the following:

          • number
          • null
        • height
          required

          One of the following:

          • number
          • null
        • duration
          required

          One of the following:

          • number
          • null
        • pages
          required

          One of the following:

          • number
          • null
      • status
        string
        required
  • 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
  • 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
  • previewed
    boolean
    required

    Whether the read's preview token is the entry's own, which shows its staged body past its gate.

  • product
    object
    required
    • 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
    • progress_tracking
      string
      required
  • 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
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