Getting started
Authentication
Coming soonAPI keys, scopes and test mode.
Planned API. This page describes the design we're building toward and may change before release. Request early access.
Authenticate with a secret API key in the Authorization header. Keys belong to a workspace and are created by a workspace admin under Settings → API keys.
| Prefix | Mode | Use |
|---|---|---|
pv_test_ | Test | Sandbox workspace with sample data. Nothing touches real tenants. |
pv_live_ | Live | Your real workspace. |
Scopes
Each key has scopes. Request only what you need.
| Scope | Grants |
|---|---|
portfolio:read | Properties, units, ownership entities |
tenancies:read / tenancies:write | Tenancies, members, rent changes |
ledger:read / ledger:write | Charges, payments, expenses |
cases:read / cases:write | Repair cases, events, photos |
stays:read / stays:write | Short-term stays and channels |
webhooks:manage | Webhook endpoints |