🚀 Beta Release — API v2 is currently in beta. While we’ve made every effort to ensure stability, there may be breaking changes before the final release.

Overview

API v2 is the next generation REST API for Password Pusher, providing a comprehensive interface for creating, retrieving, and managing secure password pushes and requests.

Key Features

Bearer Token Authentication — Secure API access with token-based authentication
JSON-Only Responses — Consistent JSON format across all endpoints
RESTful Design — Intuitive REST endpoints following best practices
Pushes & Requests — Full support for one-way pushes and two-way requests
Collections Support — Organize and manage pushes in collections
Comprehensive Audit Logs — Access detailed audit trails via API

Availability

API v2 is currently available on:

Platform	Status
pwpush.com	✅ Available
Self-Hosted Pro	✅ Available
Open Source Edition	🔜 Coming after beta

The API will be added to the open-source edition after it exits beta.

Documentation

Complete API v2 documentation is available at:

https://pwpush.com/help/api

The documentation includes:

Authentication — How to obtain and use API tokens
Pushes — Create, retrieve, preview, and expire pushes
Requests — Create and manage two-way secure requests
Accounts — List and manage accounts (where applicable)
Error Handling — Standard HTTP status codes and error responses
Rate Limits — Usage limits and best practices
Complete Examples — Working curl examples for all endpoints

Quick Example

Here’s a quick example of creating a push with API v2:

curl -X POST https://pwpush.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "MySecretPassword123",
      "expire_after_duration": 6,
      "expire_after_views": 3
    }
  }'

API v1 vs v2

Feature	API v1	API v2
Authentication	Bearer Token	Bearer Token
Response Format	JSON	JSON
Pushes	✅	✅
Requests	Limited	✅ Full Support
Collections	❌	✅
Audit Logs via API	❌	✅
Rate Limiting	Basic	Advanced

For existing integrations, API v1 continues to work and will be supported for the foreseeable future.

Feedback

We welcome your feedback on API v2! If you encounter any issues or have suggestions, please reach out through our support channels.