Password Pusher API v2

BETA

Comprehensive REST API documentation for integrating Password Pusher into your applications

Beta Notice: API v2 is currently in beta. While we've made every effort to ensure stability, there may be breaking changes before the final release. We welcome your feedback!

Workspaces

Workspaces are how Password Pusher organizes pushes and requests for teams and individuals. A user can belong to multiple workspaces. When creating pushes or requests, target a specific workspace by passing the workspace_id parameter with the workspace id.

Note: This parameter was previously named account_id and renamed to workspace_id. The legacy account_id name is still accepted for backward compatibility.

By default, you have one workspace. On pwpush.com, you can create additional workspaces for your team or organization. In Self-Hosted Pro, only one workspace is created for you.

List workspaces with GET /api/v2/workspaces or the equivalent GET /api/v1/workspaces. In API v1 and v2, the legacy paths GET /api/v1/accounts and GET /api/v2/accounts return the same JSON.

GET /api/v2/workspaces

Legacy alias: GET /api/v2/accounts (identical response).

Returns every workspace the authenticated user belongs to. Use each item’s id as workspace_id when creating pushes or requests.

Example Request

curl -X GET https://us.pwpush.com/api/v2/workspaces \
  -H "Authorization: Bearer YOUR_API_TOKEN"

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://us.pwpush.com/api/v2/workspaces')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.path)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))

import requests
import json

url = 'https://us.pwpush.com/api/v2/workspaces'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=2))

$headers = @{
    'Authorization' = 'Bearer YOUR_API_TOKEN'
}

$response = Invoke-RestMethod -Uri 'https://us.pwpush.com/api/v2/workspaces' `
    -Method Get `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Example Response

[
  {
    "id": 1,
    "name": "My Personal Workspace",
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z"
  },
  {
    "id": 2,
    "name": "Acme Corporation",
    "created_at": "2023-10-20T08:00:00.000Z",
    "updated_at": "2023-10-20T08:00:00.000Z"
  }
]

Response Fields

Field	Type	Description
`id`	integer	Numeric id of the workspace. Pass this value as `workspace_id` when creating pushes or requests.
`name`	string	Display name of the workspace
`created_at`	string (ISO 8601)	When the workspace was created
`updated_at`	string (ISO 8601)	When the workspace was last updated

Targeting a workspace

When creating pushes or requests, you can optionally pass workspace_id to associate the resource with a specific workspace. If omitted, the resource is created in your default workspace.

Note: This parameter was previously named account_id and renamed to workspace_id. The legacy account_id name is still accepted for backward compatibility, but new integrations should use workspace_id.