Subscribers

GET https://app.heypusher.com/api/subscribers/
curl --request GET \
--url 'https://app.heypusher.com/api/subscribers/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25.
{ "data": [ { "id": 1, "user_id": 1, "website_id": 1, "unique_endpoint_id": "20cdca6b287865a34365f8df7f0d57af", "endpoint": null, "ip": "**.***.***.*", "custom_parameters": [], "city_name": "Bucharest", "country_code": "RO", "continent_code": "EU", "os_name": "OS X", "browser_name": "Chrome", "browser_language": "en", "device_type": "desktop", "subscribed_on_url": "https://example.com/page", "total_sent_push_notifications": 1, "total_displayed_push_notifications": 1, "total_clicked_push_notifications": 1, "total_closed_push_notifications": 0, "last_sent_datetime": "2024-08-03 19:27:34", "last_datetime": null, "datetime": "2024-08-03 19:26:17" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://app.heypusher.com/api/subscribers?&page=1", "last": "https://app.heypusher.com/api/subscribers?&page=1", "next": null, "prev": null, "self": "https://app.heypusher.com/api/subscribers?&page=1" } }
GET https://app.heypusher.com/api/subscribers/{subscriber_id}
curl --request GET \
--url 'https://app.heypusher.com/api/subscribers/{subscriber_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "user_id": 1, "website_id": 1, "unique_endpoint_id": "20cdca6b287865a34365f8df7f0d57af", "endpoint": null, "ip": "**.***.***.*", "custom_parameters": [], "city_name": "Bucharest", "country_code": "RO", "continent_code": "EU", "os_name": "OS X", "browser_name": "Chrome", "browser_language": "en", "device_type": "desktop", "subscribed_on_url": "https://example.com/page", "total_sent_push_notifications": 1, "total_displayed_push_notifications": 1, "total_clicked_push_notifications": 1, "total_closed_push_notifications": 0, "last_sent_datetime": "2024-08-03 19:27:34", "last_datetime": null, "datetime": "2024-08-03 19:26:17" } }
POST https://app.heypusher.com/api/subscribers/{subscriber_id}
Parameters Details Description
custom_parameter_key[key] Optional String -
custom_parameter_value[key] Optional String -
curl --request POST \
--url 'https://app.heypusher.com/api/subscribers/{subscriber_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'custom_parameter_key[0]=name' \
--form 'custom_parameter_value[0]=john@example.com' \
{ "data": { "id": 1 } }
DELETE https://app.heypusher.com/api/subscribers/{subscriber_id}
curl --request DELETE \
--url 'https://app.heypusher.com/api/subscribers/{subscriber_id}' \
--header 'Authorization: Bearer {api_key}' \