Skip to content

Get a weather reading

Workforce module

GET/weather-readings/{id}weatherReadings.get

A weather reading on site, in the hazard's unit. Returns one weather reading with its `ETag`. A weather reading the caller may not see returns 404.

  • Requires the capability safety.incident.read.
  • OAuth scopes: safety.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

weatherReadings.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the weather reading.
fieldsFieldsNoSparse 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_]*)*$

Response 200: WeatherReading

weatherReadings.get: WeatherReading
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the weather reading.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
project_idstring (uuid)YesIdentifier of the project.
hazard"Wind" | "Lightning" | "Heat"YesHazard.
reading_valuenumberYesReading.Constraints: range 0 to 200
observed_atstring (date-time)YesWhen it was observed.
recorded_by_membership_idstring (uuid) | nullYesIdentifier of the member who recorded it.
{
  "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",
  "reading_value": 33,
  "observed_at": "2026-10-08T14:30:00Z",
  "recorded_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X GET "$XOS_BASE_URL/weather-readings/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.weatherReadings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.weather_readings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos weather-readings get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f