API Documentation

This is the documentation for the available API endpoints, which are built around the REST architecture. All the API endpoints will return a JSON response with the standard HTTP response codes and need a Bearer Authentication via an API Key.

API Key

Base URL

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

Example

curl --request GET \
--url 'https://pushye.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

User

Websites

Subscribers

Subscribers statistics

Subscribers logs

Campaigns

Personal notifications

RSS automations

Recurring campaigns

Flows

Segments

Notification handlers

Custom domains

My teams

Team members

Teams member

Account payments

Account logs