Skip to content

Endpoints

The API reference is grouped by module and split into two generations. Every module page lists its endpoints with parameters, a runnable example, the return shape, and the auth requirement - all generated from the API source.

v3 vs v2

  • v3 - the current generation, where new development happens. Reach for v3 first.
  • v2 - the older generation. It predates v3 and is still in active use for areas not yet covered by v3 - for example user registration, workspace and role management via network, and the v2.core.init bootstrap call.

Endpoint names carry their generation as a prefix (v3.activity.create, v2.user.register), so the two never collide. When an operation exists in both, prefer the v3 form.

A few operations are plain HTTP routes rather than RPC - file and image downloads, uploads, insight exports, and calendar feeds. See REST routes.

Browse

Hailer Developer Documentation