Reten Docs

Get Route

Get a single route with operator assignments.

GET /api/routes/:id

Returns a single route with its operator links.

Auth: Required — route:manage permission

Path Parameters

ParameterTypeDescription
idUUIDRoute ID

Example

curl https://api.reten.ai/api/routes/dd0e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
const routeId = "dd0e8400-e29b-41d4-a716-446655440000";
const response = await fetch(`https://api.reten.ai/api/routes/${routeId}`, {
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
  },
});
const route = await response.json();
import requests

route_id = "dd0e8400-e29b-41d4-a716-446655440000"
response = requests.get(
    f"https://api.reten.ai/api/routes/{route_id}",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
)
route = response.json()

Response 200 OK

{
  "id": "dd0e8400-e29b-41d4-a716-446655440000",
  "name": "North Zone",
  "code": "ZONE-NORTH",
  "description": "Northern territory coverage",
  "isActive": true,
  "operatorLinks": [
    {
      "operatorId": "cc0e8400-e29b-41d4-a716-446655440000",
      "role": "LEAD",
      "isActive": true,
      "operator": {
        "id": "cc0e8400-e29b-41d4-a716-446655440000",
        "firstName": "John",
        "lastName": "Doe",
        "type": "SALESMAN"
      }
    }
  ]
}