---
title: "Retrieve status"
description: "One customer's preorder and back-in-stock status by exact email — built for helpdesk sidebar widgets."
url: https://docs.stoqapp.com/v2-reference/customers-status/retrieve-status/
api: "API v2 reference"
method: GET
path: "/customers/status"
---

# Retrieve status

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

One customer's preorder and back-in-stock status by exact email: built for helpdesk sidebar widgets.

## Query parameters

- `email` (string, required)
- `include_checkout_text` (string)

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

## Examples

### Retrieve status

```sh
curl "https://app.stoqapp.com/api/v2/external/customers/status?email=shopper%40example.com" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Retrieve status filtered by include_checkout_text

```sh
curl "https://app.stoqapp.com/api/v2/external/customers/status?email=shopper%40example.com&include_checkout_text=Preorder%20now" \
  -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
    }
  ]
}
```