Skip to content

Paths ​

A path is a single road in the Service Road Atlas — its geometry, name, and any point features along it (gates, bridges, impasses, and so on). You'll use these endpoints to look up a specific road by ID or prefetch a region of roads for an offline map.

Fetch a single path ​

GET /api/integrations/v1/paths/{id}
Authorization: Bearer <access token>

Scope required: bulletins:read.

Response ​

Returns a GeoJSON FeatureCollection describing the road geometry and its point features. Each path contributes:

  • One LineString feature for the road itself. Properties include the path ID, name, and current composite condition.
  • Zero or more Point features for the path's gates, bridges, and other features. Each point is tagged with pathId so you can group them back to their parent road.
json
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "LineString",
        "coordinates": [[-127.67656, 50.30011], [-127.67211, 50.30021], ...]
      },
      "properties": {
        "id": "6530bb9f...",
        "name": "Example Forest Service Road",
        "length": 5125,
        "lastConditionUpdate": 1710000121111
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [-127.67400, 50.30015]
      },
      "properties": {
        "id": "abc123",
        "name": "BRIDGE_IN",
        "displayName": "Bridge In",
        "description": "Bridge was in good condition",
        "lastUpdatedAt": 171231229000
      }
    }
  ]
}

For each path feature, a separate point is made available in the FeatureCollection. The allowed types are:

WARNING, IMPASSE, BYPASS, BRIDGE_IN, BRIDGE_OUT, BRIDGE_UNKNOWN, FOOT_BRIDGE, OPEN_GATE, LOCKED_GATE, POTENTIAL_GATE, HYDROPOWER_STATIONMANAGED_OPEN_GATE and MANAGED_LOCKED_GATE

Errors ​

StatustypeWhen
404#not-foundNo path with that ID exists.

Service Road Atlas API documentation