---
title: "List notifications"
description: "List back-in-stock notifications (the send log) in this shop, paginated."
url: https://docs.stoqapp.com/v2-reference/back-in-stock-notifications/list-notifications/
api: "API v2 reference"
method: GET
path: "/back_in_stock/notifications"
---

# List notifications

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

List back-in-stock notifications (the send log) in this shop, paginated.

**Note:** status=blocked surfaces sends that did not go out, with blocked_reason (the stored text), blocked_reason_code and blocked_reason_label. Every response has a summary (total, sent, blocked, blocked_by_reason) that counts every row matching the filters, not only this page. group_by=product returns counts per product (sent, blocked, and blocked by reason code) instead of rows, paginated by product. A bare from/to date is that whole day in the shop's time zone.

## Query parameters

- `channel` (string) One of: `email`, `sms`.
- `status` (string) One of: `sent`, `blocked`.
- `group_by` (string) One of: `product`.
- `shopify_variant_id` (string)
- `shopify_product_id` (string)
- `from` (string)
- `to` (string)
- `page` (string)
- `per_page` (string)

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

## Examples

### List notifications

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

### List notifications filtered by channel, status and group_by

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/notifications?channel=email&status=sent&group_by=product" \
  -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
    }
  ]
}
```