---
title: "List sent 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-sent-notifications/
api: "API v2 reference"
method: GET
path: "/back_in_stock/notifications"
---

# List sent 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): Only notifications sent on this channel. One of: `email`, `sms`.
- `status` (string): Only notifications that went out (sent) or that were held back (blocked). One of: `sent`, `blocked`.
- `group_by` (string): Set to product to get counts per product instead of individual notifications. One of: `product`.
- `shopify_variant_id` (string): Only notifications for this Shopify variant, as a gid or a numeric id.
- `shopify_product_id` (string): Only notifications for this Shopify product, as a gid or a numeric id.
- `from` (string): Only notifications created at or after this ISO 8601 date or date-time; a bare date starts at midnight in the shop's time zone.
- `to` (string): Only notifications created at or before this ISO 8601 date or date-time; a bare date runs to the end of that day in the shop's time zone.
- `page` (integer): Page of results to return, starting at 1.
- `per_page` (integer): Results per page, 1 to 200. Default 50.

## Returns

- `notifications` (array of objects)
  - `id` (string): e.g. `string`
  - `status` (string): e.g. `string`
  - `blocked_reason` (string, nullable): e.g. `string`
  - `blocked_reason_code` (string, nullable): e.g. `string`
  - `blocked_reason_label` (string, nullable): e.g. `string`
  - `channel` (string): e.g. `string`
  - `contact` (string, nullable): e.g. `string`
  - `shopify_variant_id` (string): e.g. `string`
  - `shopify_product_id` (string): e.g. `string`
  - `product_title` (string, nullable): e.g. `string`
  - `variant_title` (string, nullable): e.g. `string`
  - `signup_id` (string): e.g. `string`
  - `attempted_at` (string): e.g. `2026-01-15T09:30:00Z`
  - `sent_at` (string, nullable): e.g. `string`
- `summary` (object)
  - `total` (integer): e.g. `1`
  - `sent` (integer): e.g. `1`
  - `blocked` (integer): e.g. `1`
  - `blocked_by_reason` (array of objects)
    - `blocked_reason_code` (string): e.g. `string`
    - `blocked_reason_label` (string): e.g. `string`
    - `count` (integer): e.g. `1`
    - `example_reason` (string): e.g. `string`
- `meta` (object): Pagination for the list.
  - `total_count` (integer): Items matching the filters, across all pages.
  - `page` (integer): Page returned, starting at 1.
  - `per_page` (integer): Most items per page.
  - `total_pages` (integer): Pages available at this per_page; 0 when nothing matches.
- `products` (array of objects)
  - `shopify_product_id` (string): e.g. `string`
  - `product_title` (string): e.g. `string`
  - `total` (integer): e.g. `1`
  - `sent` (integer): e.g. `1`
  - `blocked` (integer): e.g. `1`
  - `blocked_by_reason` (array of objects)
    - `blocked_reason_code` (string): e.g. `string`
    - `blocked_reason_label` (string): e.g. `string`
    - `count` (integer): e.g. `1`

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

## Examples

### List sent notifications

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

### List sent 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.

```json
{
  "notifications": [
    {
      "id": "string",
      "status": "string",
      "blocked_reason": "string",
      "blocked_reason_code": "string",
      "blocked_reason_label": "string",
      "channel": "string",
      "contact": "string",
      "shopify_variant_id": "string",
      "shopify_product_id": "string",
      "product_title": "string",
      "variant_title": "string",
      "signup_id": "string",
      "attempted_at": "2026-01-15T09:30:00Z",
      "sent_at": "string"
    }
  ],
  "summary": {
    "total": 1,
    "sent": 1,
    "blocked": 1,
    "blocked_by_reason": [
      {
        "blocked_reason_code": "string",
        "blocked_reason_label": "string",
        "count": 1,
        "example_reason": "string"
      }
    ]
  },
  "meta": {
    "total_count": 1,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  },
  "products": [
    {
      "shopify_product_id": "string",
      "product_title": "string",
      "total": 1,
      "sent": 1,
      "blocked": 1,
      "blocked_by_reason": [
        {
          "blocked_reason_code": "string",
          "blocked_reason_label": "string",
          "count": 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
    }
  ]
}
```

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

