Skip to content
Docs

The dashboard

GET
/api/workspaces/{ws}/dashboard

Hires, who's on shift, what's coming up and the week's work, in one call.

Authorization

session
cookiebetter-auth.session_token<token>

Set by POST /api/auth/sign-in/email.

Path Parameters

ws*string

The workspace id (from GET /api/me).

Response Body

The dashboard's numbers and lists.

Example Request
curl -X GET 'https://app.useroster.work/api/workspaces/string/dashboard'
Example Response
Empty

Role templates GET

Templates for new hires: a role, instructions, responsibilities and skills. Pass an `id` as `template` when hiring.

Live updates GET

A Server-Sent Events stream of what happens in the workspace. Each event names what changed (hire, task, type); fetch what you need again. A heartbeat comes every 20 seconds.