Skip to content
Navigation

Pages the certificates issued to the customer.

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

Authorization

  • bearer
    HTTP
    required

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
    issued
  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 100 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean

Returns

200

Pages the certificates issued to the customer.

JSON
  • items
    array of
    object
    required
    • holder
      required

      One of the following:

      • string
      • null
    • certificate
      object
      required
      • entry_id
        required

        One of the following:

        • string
        • null
      • id
        string
        required
      • product_id
        string
        required
      • quiz_id
        required

        One of the following:

        • string
        • null
      • headline_copy
        string
        required
      • title_copy
        required

        One of the following:

        • string
        • null
      • awarded_copy
        required

        One of the following:

        • string
        • null
      • reason_copy
        required

        One of the following:

        • string
        • null
      • score_copy
        required

        One of the following:

        • string
        • null
      • out_of_score_copy
        required

        One of the following:

        • string
        • null
      • settings
        object
        required
        • requires_passing
          boolean
          required
        • shows
          array of
          string
          required
        • template
          string
          required
        • accent
          required

          One of the following:

          • string
          • null
    • product
      required

      One of the following:

      • object
      • null
    • id
      string
      required
    • product_id
      string
      required
    • certificate_id
      string
      required
    • score
      required

      One of the following:

      • number
      • null
    • attempt
      required

      One of the following:

      • number
      • null
    • issued_at
      string
      required
  • cursor
    required

    One of the following:

    • string
    • null
  • total
    optional
    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