Notify Me! Public API

‍

Welcome to the **Notify Me! Public API**. This API allows you to programmatically manage subscriptions, orders, and pre-orders for your Shopify store.

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

X-Api-Key: your_api_key_here

You can generate an API key from your Notify Me! Admin Panel.

Rate Limits

To ensure fair usage and system stability, the API enforces rate limits:

Endpoint Type Limit --------------------- Standard endpoints 60 requests/minute

When you exceed the rate limit, you'll receive a `429 Too Many Requests` response.

Pagination

List endpoints return paginated results using `limit` and `offset` parameters:

Parameter Description Default Maximum ------------------------------------------ `limit` Number of results to return 15 100 `offset` Starting position in the result set 0 -

**Example:** `/v1/subscriptions/?limit=25&offset=50`

Paginated responses include:

json{ "count": 150, "next": "https://api.notify-me.io/v1/subscriptions/?limit=25&offset=75", "previous": "https://api.notify-me.io/v1/subscriptions/?limit=25&offset=25", "results": [...]}

Response Format

All responses are returned in JSON format. Successful responses include the requested data, while error responses include an `error` field with details.

Need Help?

- [Help Center](https://help.notify-me.io) - Detailed guides and tutorials- [Contact Support](mailto:support@notify-me.io) - Get help from our team