---
title: "Get a notification"
description: "Read whether one back-in-stock notification sends and, for the reminder, when. key is \"signup_thank_you\", \"restock_alert\" or \"reminder\"."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-notification-settings/get-a-notification/
api: "API v2 reference"
method: GET
path: "/back_in_stock/notification_settings/{key}"
---

# Get a notification

`GET https://app.stoqapp.com/api/v2/external/back_in_stock/notification_settings/{key}`

Read whether one back-in-stock notification sends and, for the reminder, when. key is &quot;signup_thank_you&quot;, &quot;restock_alert&quot; or &quot;reminder&quot;.

**Note:** [`GET /back_in_stock/notification_settings`](https://docs.stoqapp.com/v2-reference/back-in-stock-notification-settings/list-notification-settings/) reads all three at once; PATCH this path to change one. For `restock_alert`, `enabled` is the shop's &quot;Send automatic notification&quot; switch: false means no automatic alerts go out when stock returns. `after_n_days` is returned for `reminder` only. A key the shop has no notification for gives 404 `not_found`; a key outside the three gives 422 `invalid_params`. The copy is [`GET /back_in_stock/templates/:key`](https://docs.stoqapp.com/v2-reference/back-in-stock-templates/get-a-template/).

## Path parameters

- `key` (string, required): Which notification: signup_thank_you, restock_alert or reminder. One of: `signup_thank_you`, `restock_alert`, `reminder`.

## Returns

The [notification setting object](https://docs.stoqapp.com/v2-reference/back-in-stock-notification-settings/).

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/notification_settings/{key}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "key": "string",
  "enabled": true,
  "after_n_days": 1
}
```

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

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "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
    }
  ]
}
```

