---
title: "List customers"
description: "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."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-customers/list-customers/
api: "API v2 reference"
method: GET
path: "/back_in_stock/customers"
---

# List customers

`GET https://app.stoqapp.com/api/v2/external/back_in_stock/customers`

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.

## Query parameters

- `query` (string)
- `page` (string)
- `per_page` (string)

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/customers" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

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

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```