List customers

GET

/back_in_stock/customers

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/back_in_stock/customers?query=string&page=string&per_page=string' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

List the shop’s customers (everyone who signed up for an alert or placed a preorder), newest first, as the Reports page’s Customers tab does.

Note: query matches part of the customer’s email or phone, like the tab’s search. unsubscribed_at is set when the customer is unsubscribed from back-in-stock notifications. accepts_marketing is the marketing consent they gave.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

query

Example

string

page

Example

string

per_page

Example

string

Responses

200

Success — the requested resource.

Media typeapplication/json

object

Example ^generated

{}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}