REST API Reference

https://pushary.com/api/v1/server

Authorization: Bearer pk_xxx.sk_xxx

curl -X GET https://pushary.com/api/v1/server/subscribers \
  -H "Authorization: Bearer pk_abc123.sk_secret456"

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key. Use Authorization: Bearer pk_xxx.sk_xxx"
}

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1704067200

{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Please retry after 60 seconds.",
  "retryAfter": 60
}

{
  "data": [...],
  "hasMore": true,
  "nextCursor": "abc123"
}

curl "https://pushary.com/api/v1/server/subscribers?limit=50&cursor=abc123" \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

curl -X POST https://pushary.com/api/v1/server/send \
  -H "Authorization: Bearer pk_xxx.sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New Message",
    "body": "You have a new notification",
    "url": "https://example.com/messages"
  }'

curl -X POST https://pushary.com/api/v1/server/send \
  -H "Authorization: Bearer pk_xxx.sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Welcome Back!",
    "body": "We missed you",
    "externalIds": ["user_123", "user_456"]
  }'

{
  "success": true,
  "campaignId": "camp_abc123",
  "sent": 150,
  "limits": {
    "remaining": 9850,
    "limit": 10000
  }
}

GET /subscribers

curl "https://pushary.com/api/v1/server/subscribers?status=active&limit=50" \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

{
  "data": [
    {
      "id": "sub_abc123",
      "siteId": "site_xyz",
      "status": "active",
      "externalId": "user_123",
      "tags": ["premium", "newsletter"],
      "browser": "Chrome",
      "os": "Windows",
      "country": "US",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "sub_def456"
}

GET /subscribers/:id

curl https://pushary.com/api/v1/server/subscribers/sub_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

PATCH /subscribers/:id

curl -X PATCH https://pushary.com/api/v1/server/subscribers/sub_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": ["premium", "early-access"],
    "externalId": "user_456",
    "customData": {"plan": "pro"}
  }'

DELETE /subscribers/:id

curl -X DELETE https://pushary.com/api/v1/server/subscribers/sub_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

{
  "success": true
}

GET /subscribers/count

curl https://pushary.com/api/v1/server/subscribers/count \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

{
  "total": 1500,
  "active": 1200,
  "unsubscribed": 300
}

GET /campaigns

curl "https://pushary.com/api/v1/server/campaigns?limit=20" \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

{
  "data": [
    {
      "id": "camp_abc123",
      "name": "Welcome Campaign",
      "title": "Welcome!",
      "body": "Thanks for subscribing",
      "status": "draft",
      "totalTargeted": 0,
      "totalSent": 0,
      "totalDelivered": 0,
      "totalClicked": 0,
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

POST /campaigns

curl -X POST https://pushary.com/api/v1/server/campaigns \
  -H "Authorization: Bearer pk_xxx.sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Launch",
    "title": "New Feature Available!",
    "body": "Check out our latest update",
    "actionUrl": "https://example.com/new-feature"
  }'

GET /campaigns/:id

curl https://pushary.com/api/v1/server/campaigns/camp_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

PATCH /campaigns/:id

curl -X PATCH https://pushary.com/api/v1/server/campaigns/camp_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated Title",
    "body": "Updated body text"
  }'

DELETE /campaigns/:id

curl -X DELETE https://pushary.com/api/v1/server/campaigns/camp_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

POST /campaigns/:id/send

curl -X POST https://pushary.com/api/v1/server/campaigns/camp_abc123/send \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

GET /templates

curl "https://pushary.com/api/v1/server/templates" \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

{
  "data": [
    {
      "id": "tmpl_abc123",
      "name": "Welcome Template",
      "title": "Welcome to {{siteName}}!",
      "body": "Thanks for subscribing, {{userName}}",
      "iconUrl": null,
      "imageUrl": null,
      "actionUrl": "https://example.com/welcome",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

POST /templates

curl -X POST https://pushary.com/api/v1/server/templates \
  -H "Authorization: Bearer pk_xxx.sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Order Confirmation",
    "title": "Order Confirmed!",
    "body": "Your order #{{orderId}} has been confirmed",
    "actionUrl": "https://example.com/orders/{{orderId}}"
  }'

GET /templates/:id

curl https://pushary.com/api/v1/server/templates/tmpl_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

PATCH /templates/:id

curl -X PATCH https://pushary.com/api/v1/server/templates/tmpl_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated Title",
    "body": "Updated body with {{variable}}"
  }'

DELETE /templates/:id

curl -X DELETE https://pushary.com/api/v1/server/templates/tmpl_abc123 \
  -H "Authorization: Bearer pk_xxx.sk_xxx"

{
  "error": "Error Type",
  "message": "Human-readable description"
}

{
  "error": "Notification limit exceeded",
  "message": "You've reached your monthly notification limit",
  "upgradeUrl": "https://pushary.com/pricing"
}

{
  "error": "Missing required fields: title, body"
}