Set up a counter
Workforce module
POST/occupancy-counters/set-upoccupancyCounters.setUp
Sets up a counter sized by a permit load, a Bible occupant load factor or the space capacity. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability safety.emergency_code.write.
- OAuth scopes: safety.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: OccupancyCounterCreateRequest
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Project. |
| name | string | Yes | Counter name.Constraints: length 1 to 120 |
| space_id | string (uuid) | No | Space counted. |
| metric_item | string | No | Bible occupant load factor sizing the space. |
| permitted_load | integer | No | Permitted load from a permit.Constraints: range 1 to any |
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Main Floor",
"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"metric_item": "Assembly - standing space",
"permitted_load": 400
}Response 201: OccupancyCounter
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the occupancy counter. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| space_id | string (uuid) | null | Yes | Identifier of the space counted. |
| name | string | Yes | Counter name.Constraints: length 1 to 120 |
| load_basis | "Occupant Load Factor" | "Space Capacity" | "Permit" | Yes | Where the permitted load comes from. |
| metric_domain | string | null | Yes | Bible metric domain of the load factor.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| metric_item | string | null | Yes | Bible occupant load factor.Constraints: length 1 to 300 |
| permitted_load | integer | Yes | Permitted occupant load.Constraints: range 1 to any |
| current_count | integer | Yes | People inside now.Constraints: range 0 to any |
| alert_level_percent | integer | Yes | Highest alert level met: 0, 80, 90 or 100.Constraints: range 0 to any |
| closed_at | string (date-time) | null | Yes | When counting stopped. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Main Floor",
"load_basis": "Occupant Load Factor",
"metric_domain": "capacity",
"metric_item": "Assembly - standing space",
"permitted_load": 100,
"current_count": 82,
"alert_level_percent": 80,
"closed_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/occupancy-counters/set-up" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Main Floor","space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","metric_item":"Assembly - standing space","permitted_load":400}'const { data } = await xos.occupancyCounters.setUp({
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Main Floor",
"space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"metric_item": "Assembly - standing space",
"permitted_load": 400
});response = xos.occupancy_counters.set_up({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "name": "Main Floor", "space_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "metric_item": "Assembly - standing space", "permitted_load": 400})xos occupancy-counters set-up --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","name":"Main Floor","space_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","metric_item":"Assembly - standing space","permitted_load":400}'