Notify Me! Public API (v1)
The interactive reference on this page requires JavaScript. The complete, machine-readable contract is the
OpenAPI 3.0 schema — every endpoint below is fully documented there.
Essentials
- Base URL:
https://api.notify-me.app/v1/
- Authentication:
X-Api-Key: <key> request header. Keys are generated in the Notify Me! Admin Panel (Settings → API keys). Bearer auth is not used by the REST API.
- The REST API is read-only (GET endpoints only). There is no public write/subscribe endpoint — shopper signups happen through the storefront widget.
- Errors: 401 invalid key, 403 permission/entitlement denied, 404 not found, 429 rate limited (60 requests/minute).
- Pagination:
limit (default 15, max 100) and offset query parameters.
Endpoints
GET /v1/subscriptions/ — back-in-stock subscriptions (filter by status, product, variant, email, dates)GET /v1/subscriptions/{id}/GET /v1/subscription-notifications/ — alerts already sent, with per-channel delivery statusGET /v1/subscription-notifications/{id}/GET /v1/pre-orders/ — pre-orders with financial and fulfillment statusGET /v1/pre-orders/{id}/GET /v1/pre-order-notifications/GET /v1/pre-order-notifications/{id}/
MCP server (writes live here)
https://mcp.notify-me.app/mcp — Streamable HTTP transport; Authorization: Bearer <api key>; requires the mcp entitlement. Tools cover reading shop settings and aggregate analytics, and updating settings and widget appearance.
More: help article · static HTML reference · llms.txt