List weather threshold rows
Workforce module
GET/weather-thresholdsweatherThresholds.list
A weather action threshold of a project: one value per hazard and level, with its emergency plan source. Returns a cursor page of weather threshold rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability safety.incident.read.
- OAuth scopes: safety.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: 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).Constraints: 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. |
Response 200: a page of WeatherThreshold
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the weather threshold. |
| 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. |
| hazard | "Wind" | "Lightning" | "Heat" | Yes | Hazard. |
| alert_level | "Monitor" | "Restrict" | "Evacuate" | Yes | Level. |
| threshold_value | number | Yes | Value that triggers the level.Constraints: range 0 to 200 |
| unit | "mph" | "mi" | "F" | Yes | Unit: mph for wind, mi for lightning distance, F for heat index. |
| comparison | "At or Above" | "At or Below" | Yes | At or Above for wind and heat, At or Below for lightning. |
| source_note | string | Yes | Where the value comes from.Constraints: length 1 to 300 |
{
"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",
"hazard": "Wind",
"alert_level": "Monitor",
"threshold_value": 30,
"unit": "mph",
"comparison": "At or Above",
"source_note": "Emergency plan 4.2"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/weather-thresholds" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.weatherThresholds.listAll()) {
console.log(row);
}for row in xos.weather_thresholds.list_all():
print(row)xos weather-thresholds list --all