> ## Documentation Index
> Fetch the complete documentation index at: https://codebeans-cb-notifylyst.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API

> Connect your own systems to Notifylyst: add and list sign-ups, read opt-outs, the waiting list, sent messages and your headline numbers.

The Notifylyst REST API lets your own software talk to your store's Notifylyst data — a warehouse
system, a CRM, a BI tool, a Zapier or Make scenario, or a script you write. It is a plain HTTPS +
JSON API with one key per store.

> [card] [Quickstart](https://codebeans-cb-notifylyst.mintlify.site/api/quickstart.md)
>
> Your first request in two minutes.

> [card] [Authentication & limits](https://codebeans-cb-notifylyst.mintlify.site/api/authentication.md)
>
> The key, the rate limit, paging and errors.

> [card] [Subscribers](https://codebeans-cb-notifylyst.mintlify.site/api/subscribers.md)
>
> Add sign-ups one at a time or in bulk, list them, cancel or re-send.

> [card] [Reports & opt-outs](https://codebeans-cb-notifylyst.mintlify.site/api/reports.md)
>
> Opt-outs, the waiting list, the send log and your headline numbers.

## What you can do

| Group | Method | Path | What it does |
| - | - | - | - |
| Account | `GET` | `/api/v1` | Lists every endpoint and webhook event. No key needed. |
| Account | `GET` | `/api/v1/me` | Checks your key and returns your store, time zone and rate limit. |
| Subscribers | `GET` | `/api/v1/subscribers` | Lists sign-ups, newest first, with filters. |
| Subscribers | `POST` | `/api/v1/subscribers` | Adds one sign-up. |
| Subscribers | `POST` | `/api/v1/subscribers/bulk` | Adds up to 250 sign-ups in one call. |
| Subscribers | `GET` | `/api/v1/subscribers/{id}` | Returns one sign-up. |
| Subscribers | `POST` | `/api/v1/subscribers/{id}/cancel` | Cancels a sign-up that is still waiting. |
| Subscribers | `POST` | `/api/v1/subscribers/{id}/resend` | Sends the restock email for one sign-up again. |
| Opt-outs | `GET` | `/api/v1/unsubscribes` | Lists opt-outs. |
| Opt-outs | `POST` | `/api/v1/unsubscribes` | Opts an email or phone number out. |
| Products | `GET` | `/api/v1/products/waitlist` | Variants ranked by how many people are waiting. |
| Messages | `GET` | `/api/v1/notifications` | The restock messages that were sent. |
| Analytics | `GET` | `/api/v1/analytics/summary` | Sign-ups, messages sent and recovered revenue for a period. |

**Base URL:** `https://cb-notifylyst.cblyst.com/api/v1`

## Before you start

* Your plan must include **REST API**. See [Plan features](https://codebeans-cb-notifylyst.mintlify.site/app/reference/plan-features.md).
* Get your key from **Settings → API key** in the app. See [Authentication & limits](https://codebeans-cb-notifylyst.mintlify.site/api/authentication.md).
* Requests and responses are JSON. Dates are ISO 8601 in UTC.

## Push, not pull

The API answers when you ask. To be **told** the moment something happens — a new sign-up, a sent
alert, a purchase after an alert — use [webhooks](https://codebeans-cb-notifylyst.mintlify.site/api/webhooks.md) instead of polling.

> [!NOTE]
>
> The API works with your own store's data only. A key can never read or change another store.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.