Developer portal
Allocation guide
Shift grids, skills, and coverage rules — documented now, solver shipping next.
Pilot
When to use allocation
Cover shifts with the right skills while minimizing overtime and respecting fatigue rules.
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
| shifts[].id | string | Yes | Shift to cover. |
| shifts[].requiredSkill | string | No | Skill required on the shift. |
| staff[].name | string | Yes | Person identifier. |
| staff[].skills | string[] | No | Certifications and roles. |
| constraints[] | string[] | No | Coverage and fatigue rules. |
Example payload
{
"type": "allocation",
"shifts": [
{
"id": "morning",
"requiredSkill": "operator"
},
{
"id": "swing",
"requiredSkill": "operator"
},
{
"id": "night",
"requiredSkill": "lead"
}
],
"staff": [
{
"name": "Alicia",
"skills": [
"operator",
"lead"
]
},
{
"name": "Noah",
"skills": [
"operator"
]
},
{
"name": "Priya",
"skills": [
"operator"
]
},
{
"name": "Devin",
"skills": [
"lead"
]
}
],
"constraints": [
"No back-to-back night and morning shifts",
"Minimize overtime"
]
}Found an issue? Report documentation feedback