Skip to content
Docs

List hires

GET
/api/workspaces/{ws}/hires

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

Every hire in the workspace.

application/json
Example Request
curl -X GET 'https://app.useroster.work/api/workspaces/string/hires'
Example Response
[  {    "id": "3f0c2a7e-6b1d-4c55-9a51-2f4d8e9b7a10",    "displayName": "Builder",    "slug": "builder",    "role": "Software engineer",    "instructions": "You own the web app's build and its CI.",    "status": "active",    "autonomy": "ask",    "timezone": "Europe/Berlin",    "workingHours": {      "days": [        1,        2,        3,        4,        5      ],      "start": "09:00",      "end": "18:00"    },    "home": null,    "voice": "",    "reactions": {      "onPickup": false,      "wakeOn": [        "❓",        "❌"      ]    },    "browser": false,    "desktop": false,    "listen": {      "mentions": true,      "threads": true,      "directMessages": true,      "channels": false,      "chattiness": "normal"    },    "allow": {      "humans": "anyone",      "agents": [],      "maxAgentTurns": 4    },    "chat": [],    "tools": [],    "onShift": false,    "onboardedAt": null,    "createdAt": "2026-11-03T09:00:00.000Z"  }]

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.

Hire someone POST

Only `displayName` and `slug` are needed. With `template`, the role's instructions, responsibilities and skills are filled in for what you leave out.