Open interactive API reference (English) ↗
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
kkk
Get Pre Order Sent Notification
Retrieve details of a specific pre order sent notification by ID.
GET /v1/pre-order-notifications/{id}/
Retrieve details of a specific pre order sent notification by ID.
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/pre-order-notifications/{id}/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
404
Object not found
Get Shop Pre Order
Retrieve details of a specific shop pre order by ID.
GET /v1/pre-orders/{id}/
Retrieve details of a specific shop pre order by ID.
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/pre-orders/{id}/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
404
Object not found
Get Subscription
Retrieve details of a specific subscription by ID.
GET /v1/subscriptions/{id}/
Retrieve details of a specific subscription by ID.
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/subscriptions/{id}/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
404
Object not found
Get Subscription Sent Notification
Retrieve details of a specific subscription sent notification by ID.
GET /v1/subscription-notifications/{id}/
Retrieve details of a specific subscription sent notification by ID.
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/subscription-notifications/{id}/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
404
Object not found
Push notifications
Launched in 2020, “Notify Me” is responsible for completing the mission to help Shopify stores grow their business and increase their net profit. Any use of the service is subject to terms described in this Terms of Service and by subscribing or using the Services, you (“you” or “Client”) acknowledge that you have read, understood, and agreed to the entirety of these Terms of Service.
These Terms of Service may be amended from time to time due to changes in service features or other reasons. It is the Client’s responsibility to review these Terms of Service frequently and to remain informed of any changes implemented. The Client agrees that the continued use of the Service after such changes to the Terms of Services have been published will constitute the Client’s acceptance of such revised terms.
Definitions 11
Notify Me is always innovating and upgrading the Service Notify Me is always innovating and upgrading the Service innovating and upgrading the
String
curl --request POST \
--url 'https://a.klaviyo.com/client/events/?company_
id=COMPANY_ID'
--header 'Content-Type: application/json'
--data '{DATA}'
awdawd
Review insights around how and when products in your catalog are driving orders Review insights around how and when products in your catalog are driving orders
Review insights around how and when products in your catalog are dhts around how and when products in your catalog are driving orders
Pre Order Sent Notifications List
Retrieve a paginated list of pre order sent notifications for your shop.
GET /v1/pre-order-notifications/
Retrieve a paginated list of pre order sent notifications for your shop.
Parameters
email_status
array
optional
phone_number
string
optional
pre_order_id
integer
optional
sent_at_gte
string
optional
sent_at_lte
string
optional
sms_status
array
optional
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/pre-order-notifications/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
Shop Pre Orders List
Retrieve a paginated list of shop pre orders for your shop.
GET /v1/pre-orders/
Retrieve a paginated list of shop pre orders for your shop.
Parameters
cancelled_at_isnull
boolean
optional
created_at_gte
string
optional
created_at_lte
string
optional
financial_status
array
optional
fulfillment_status
array
optional
offer_name
string
optional
product_id
integer
optional
shopify_order_id
integer
optional
variant_id
integer
optional
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/pre-orders/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
awd
awdawdd
Definitions
Notify Me is always innovating and upgrading the Service Notify Me is always innovating and upgrading the Service innovating and upgrading the
String
curl --request POST \
--url 'https://a.klaviyo.com/client/events/?company_
id=COMPANY_ID'
--header 'Content-Type: application/json'
--data '{DATA}'
curl --request POST \
--url 'https://a.klaviyo.com/client/events/?company_id=COMPANY_ID'
--header 'Content-Type: application/json'
--data '{DATA}'
Notify Me is always innovating and upgrading the Service, which is accompanied by changing the features of Notify Me app/ Therefore, you
2024-10-15.pre
List account exports
Review insights around how and when products in your catalog are driving orders Review insights around how and when products in your catalog are driving orders
Review insights around how and when products in your catalog are dhts around how and when products in your catalog are driving orders
List account exports
Review insights around how and when products in your catalog are driving orders Review insights around how and when products in your catalog are driving orders
Review insights around how and when products in your catalog are dhts around how and when products in your catalog are driving orders
List account exports
Review insights around how and when products in your catalog are driving orders Review insights around how and when products in your catalog are driving orders
Review insights around how and when products in your catalog are dhts around how and when products in your catalog are driving orders
Sms
Subscription Sent Notifications List
Retrieve a paginated list of subscription sent notifications for your shop.
GET /v1/subscription-notifications/
Retrieve a paginated list of subscription sent notifications for your shop.
Parameters
email_status
array
optional
phone_number
string
optional
product_id
number
optional
push_status
array
optional
sent_at_gte
string
optional
sent_at_lte
string
optional
sms_status
array
optional
subscription_id
number
optional
variant_id
number
optional
whatsapp_number
string
optional
whatsapp_status
array
optional
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/subscription-notifications/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
Subscriptions List
Retrieve a paginated list of subscriptions for your shop.
GET /v1/subscriptions/
Retrieve a paginated list of subscriptions for your shop.
Parameters
created_at_gte
string
optional
created_at_lte
string
optional
is_imported
boolean
optional
phone_number
string
optional
product_id
number
optional
sent_at_gte
string
optional
sent_at_isnull
boolean
optional
sent_at_lte
string
optional
subscribe_at_gte
string
optional
subscribe_at_lte
string
optional
variant_id
number
optional
whatsapp_number
string
optional
cURL Example
Sample request using cURL
Request
curl -X GET "https://api.notify-me.app/v1/subscriptions/" \
-H "X-Api-Key: YOUR_API_KEY"
200
Response
See example response in documentation
401
Authentication failed
Response
See example response in documentation
403
Permission denied
429
Rate limit exceeded
