Skip to content

Developer overview

The Sesharo apps (iOS, web, and the desktop plugins) are all clients of one HTTP API. That same API is documented here, so anything the apps can do, you can do.

Environment Base URL
Production https://api.sesharo.com
Staging https://staging-api.sesharo.com
Local http://localhost:8000

The interactive API Reference is generated directly from the API’s OpenAPI 3.1 specification, so it always reflects the real request/response shapes.

  • REST + JSON. Resources are addressed by path (for example /users/{id}/events), and request/response bodies are JSON.
  • Per-user data. Almost every resource is scoped to a user and isolated at the database level — you only ever see your own data.
  • Auth via bearer token. Obtain a token by logging in, then send it on every request. See Authentication.

The reference is built from a committed snapshot of the spec (src/openapi/sesharo-api.json in the docs repo), refreshed from the staging API. You can also fetch the live spec yourself from staging at https://staging-api.sesharo.com/openapi.json.

This published reference is a curated subset of the full API. Operational and internal-only endpoints — admin, provider-integration connect/callback flows, and user-listing — are intentionally omitted here. They still exist on the API; they’re just not documented publicly. The curation rules live in scripts/fetch-openapi.sh.