Get started ↗

Last updated

// 00 — API references

API references

wspc exposes a typed HTTP surface per domain. Each domain ships an OpenAPI document at a fixed URL. The pages below are live — request shapes, response schemas, and example payloads match the deployed server.

Pick a domain:

  • Auth API ↗ — public OAuth and protected account, Workspace, and API Key operations.
  • Todo API ↗ — tasks with hierarchy, status, due dates, RRULE recurrence, optimistic locking.
  • Calendar API ↗ — events with attendees, ICS export, natural-language time parsing.
  • Email API ↗ — aliases, inbound mail, outbound send, and attachments.
  • Drive API ↗ — libraries, files, retained versions, and exports.
  • Push API ↗ — per-user notification configuration.
  • Billing API ↗ — Current Workspace entitlements and subscription operations.

Protected REST operations accept a WSPC OAuth 2.1 access token or a long-lived WSPC API key as the Bearer credential. Public OAuth operations, health endpoints, and provider callbacks follow the security contracts declared by their respective OpenAPI operations.