Skip to content
Docs

Hire someone

POST
/api/workspaces/{ws}/hires

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

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).

Request Body

application/json
  1. body
displayName*string
Length1 <= length <= 80
slug*string
Match^[a-z0-9][a-z0-9-]{0,39}$
instructions?string
Lengthlength <= 20000
Default""
listen?
Default{}
allow?
Default{}
status?string
Default"active"
Value in"active""paused"
role?string
Lengthlength <= 80
Default""
timezone?string
Length1 <= length
Default"UTC"
workingHours?|null
home?|
Defaultnull
autonomy?string
Default"ask"
Value in"ask""act"
voice?string
Lengthlength <= 600
Default""
reactions?
Default{}
browser?boolean
Defaultfalse
desktop?boolean
Defaultfalse
level?string
Default"hire"
Value in"hire""senior"
template?string

A role id from GET /api/roles; fills what you leave out.

Response Body

The new hire.

application/json
Example Request
curl -X POST 'https://app.useroster.work/api/workspaces/string/hires' \  -H 'Content-Type: application/json' \  -d '{  "displayName": "string",  "slug": "string"}'
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"}