---
title: "Get alert settings"
description: "Read back-in-stock merchant alert and scheduled report settings."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-settings/get-alert-settings/
api: "API v2 reference"
method: GET
path: "/back_in_stock/settings/alerts"
---

# Get alert settings

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

Read back-in-stock merchant alert and scheduled report settings.

**Note:** These emails go to the merchant, never to shoppers. `scheduled_reports.email` is the main merchant address: it gets the daily, weekly and monthly reports, the waitlist-threshold alert (one email per variant once its waitlist reaches `signups_threshold.count`) and the alerts-sent email. `signup_alerts.email` is used only for the every-signup alert. Change these with [`PATCH /back_in_stock/settings/alerts`](https://docs.stoqapp.com/v2-reference/back-in-stock-settings/update-alert-settings/).

## Returns

- `signups_threshold` (object)
  - `count` (integer): e.g. `1`
  - `notify` (boolean): e.g. `true`
- `signup_alerts` (object)
  - `enabled` (boolean): e.g. `true`
  - `email` (null)
- `scheduled_reports` (object)
  - `daily` (boolean): e.g. `true`
  - `weekly` (boolean): e.g. `true`
  - `monthly` (boolean): e.g. `true`
  - `email` (null)
- `notify_on_alert_sent` (boolean): e.g. `true`
- `merchant_emails` (object)
  - `product_updates` (boolean): e.g. `true`
  - `theme_published` (boolean): e.g. `true`

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/settings/alerts" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "signups_threshold": {
    "count": 1,
    "notify": true
  },
  "signup_alerts": {
    "enabled": true,
    "email": null
  },
  "scheduled_reports": {
    "daily": true,
    "weekly": true,
    "monthly": true,
    "email": null
  },
  "notify_on_alert_sent": true,
  "merchant_emails": {
    "product_updates": true,
    "theme_published": true
  }
}
```

## 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
    }
  ]
}
```

