API Introduction

Base URL, authentication, response format, and endpoint groups for the Notify Partners API

Base URL

https://api.notify.partners/api/v3/

Authentication

All API requests require an Authorization header. Two authentication methods are supported:

1. JWT Token (email/password)

Obtain a token via the login endpoint, then use it in the header:

POST /api/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "your_password"
}

Response:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Usage:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

JWT tokens are suitable for interactive sessions and dashboard usage.

2. API Key

Create an API key in the Settings → API Keys section of the dashboard. Keys are prefixed with psk_live_.

Authorization: Bearer psk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API keys support scoping — binding to a specific project. A key scoped to a project can only access resources within that project. Keys with the "admin" scope provide access to administrative endpoints.

Response Format

Successful responses return a JSON object or array containing the data.

Example of a successful response:

{
  "id": 42,
  "name": "My App",
  "created_at": "2026-03-18T10:00:00Z"
}

Errors are always returned in the following format:

{
  "error": "error description"
}

with the corresponding HTTP status code.

Error Codes

HTTP Status	Description
`400`	Validation error — invalid data format or missing required fields
`401`	Unauthorized — missing or invalid token
`403`	Forbidden — insufficient permissions (e.g., admin access required)
`404`	Resource not found
`409`	Conflict — duplicate unique resource (e.g., email already registered)
`500`	Internal server error

Endpoint Groups

Group	Description
Auth	Registration, login, profile
Apps	Application management (CRUD, credentials)
App Groups	Grouping applications
Pushes	Push notification templates (translations, macros)
Schedulers	Send tasks (instant, one-time, weekly, event-triggered)
Analytics	Statistics: Sent, Delivered, Clicked, CTR
Push Packs	Sets of automated pushes by schedule and events
Devices	Device management
API Keys	Creating and managing API keys
Events	Custom events for trigger-based campaigns
Admin	Administrative endpoints (require admin access)

Example Request

Retrieve the list of applications:

curl -X GET "https://api.notify.partners/api/v3/apps" \
  -H "Authorization: Bearer psk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Response:

[
  {
    "id": 1,
    "name": "My Android App",
    "platform": "android",
    "created_at": "2026-03-01T12:00:00Z"
  },
  {
    "id": 2,
    "name": "My Web App",
    "platform": "web",
    "created_at": "2026-03-05T09:30:00Z"
  }
]

On this page