# Notify Me!™ Public API

> Read-only REST API for Notify Me!™, the Shopify back-in-stock / preorder / wishlist / low-stock app. This file gives AI assistants and crawlers the authoritative API facts and URLs.

**API facts**

- Base URL: https://api.notify-me.app/v1/ — note the .app TLD (the marketing site is on notify-me.io; there is no REST API on .io).
- The REST API is read-only: GET-only endpoints for subscriptions, subscription notifications, pre-orders, and pre-order notifications. There is no public REST write/subscribe endpoint — shopper signups happen through the storefront widget.
- Authentication: `X-Api-Key: <key>` request header (NOT `Authorization: Bearer`). Keys are generated in the Notify Me! Admin Panel (Settings → API keys).
- Auth failures return 401 (invalid key) or 403 (missing entitlement/permission). Rate limit: 60 requests/minute; 429 on excess.
- Pagination: `limit` (default 15, max 100) and `offset` query parameters.

**MCP server (writes live here)**

- Endpoint: https://mcp.notify-me.app/mcp (Streamable HTTP transport)
- Auth: `Authorization: Bearer <api key>`; requires the `mcp` entitlement (separate from the Public API entitlement).
- Tools: read shop settings and aggregate analytics (PII-safe), update settings and widget appearance. The MCP tool list is documented in the "MCP Server" section of https://api.notify-me.app/v1/docs/.

## Start here

- [OpenAPI 3.0 schema](https://api.notify-me.app/v1/schema/): machine-readable, the full contract — every endpoint is fully documented here
- [Interactive docs](https://api.notify-me.app/v1/docs/): JS-rendered Redoc reference
- [Static HTML reference](https://notify-me.io/api-reference): full reference, no JS needed
- [Public API help article](https://help.notify-me.io/en/articles/13184354-notify-me-public-api): creating and managing API keys

## Product

- [Website](https://notify-me.io/)
- [Shopify App Store listing](https://apps.shopify.com/preorder-back-in-stock)
- [Help center](https://help.notify-me.io/)
- [Status page](https://notify-me.statuspage.io/)
- [Support](mailto:support@notify-me.io)