API v1

All documented public integration API endpoints are available under:

• /api/v1/...

Authentication

Account-scoped endpoints require:

• secret header with an account secret
• x-account-access-id header with the current account access ID

Included documents

• Public endpoints
• Authentication
• Account, e-mail addresses, secrets, and linked users
• Aliases, alias lengths, domains, and 10-minute aliases
• Plans, add-ons, orders, payments, and receipts
• Friends and groups
• Business cards
• QR codes and vCard sharing
• Announcements and blog

Conventions

• JSON is used unless stated otherwise.
• Policy-document endpoints are the only anonymous end-user API endpoints documented under /api/v1/....
• Account-scoped routes resolve data strictly for the account identified by secret and x-account-access-id.