List occupancy counter rows
Módulo Workforce
GET/occupancy-countersoccupancyCounters.list
A live occupancy counter against the permitted occupant load, with alerts at 80, 90 and 100 percent. Returns a cursor page of occupancy counter rows the caller may see. The default order is `name` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad safety.incident.read.
- Alcances de OAuth: safety.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Respuesta 200: una página de OccupancyCounter
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the occupancy counter. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Person who last updated the row; null for seed, platform or system writes. |
| project_id | string (uuid) | Sí | Identifier of the project. |
| space_id | string (uuid) | null | Sí | Identifier of the space counted. |
| name | string | Sí | Counter name.Restricciones: length 1 to 120 |
| load_basis | "Occupant Load Factor" | "Space Capacity" | "Permit" | Sí | Where the permitted load comes from. |
| metric_domain | string | null | Sí | Bible metric domain of the load factor.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| metric_item | string | null | Sí | Bible occupant load factor.Restricciones: length 1 to 300 |
| permitted_load | integer | Sí | Permitted occupant load.Restricciones: range 1 to any |
| current_count | integer | Sí | People inside now.Restricciones: range 0 to any |
| alert_level_percent | integer | Sí | Highest alert level met: 0, 80, 90 or 100.Restricciones: range 0 to any |
| closed_at | string (date-time) | null | Sí | When counting stopped. |
{
"data": [
{
"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"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/occupancy-counters" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.occupancyCounters.listAll()) {
console.log(row);
}for row in xos.occupancy_counters.list_all():
print(row)xos occupancy-counters list --all