Skip to content
Navigation

Pages a product's customers.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/customers

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • 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
    started
    or
    date
    or
    name

    Sorted by name, rows without a value come last either way.

  • direction
    optional
    asc
    or
    desc
  • limit
    optional
    integer
    maximum: 1000 · minimum: 1
  • cursor
    optional
    string
    maxLength: 8192
  • count
    optional
    boolean
  • search
    optional
    string
    maxLength: 200 · minLength: 1
  • facets
    optional
    array of
    string

Returns

200

Pages a product's customers.

JSON
  • items
    array of
    object
    required
    • started_at
      string
      required
    • ends_at
      required

      One of the following:

      • string
      • null
    • progress
      object
      required
      • completed
        number
        required
      • total
        number
        required
    • answers
      array of
      object
      required

      Their answers to the product's registration questions, in the questions' order.

      • question_id
        string
        required
      • value
        required

        One of the following:

        • boolean
        • string
        • array<string>
    • actions
      required

      A subscription's moves, as getSubscription answers them; null for a grant.

      One of the following:

      • object
      • null
    • next_event
      required

      A subscription's next event, as getSubscription answers it; null for a grant.

      One of the following:

      • object
      • null
    • id
      string
      required
    • kind
      string
      required
    • source_kind
      required

      One of the following:

      • string
      • null
    • customer_id
      string
      required
    • customer
      required

      One of the following:

      • object
      • null
    • price_id
      required

      One of the following:

      • string
      • null
    • order_id
      required

      One of the following:

      • string
      • null
    • cancel_reason
      required

      One of the following:

      • string
      • null
    • status
      string
      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