---
title: "Get routes associated with the user"
method: GET
path: "/v1/resourceowner/routeplanner/routes"
tags: ["ResourceOwnerRoutePlanner"]
---

# Get routes associated with the user

`GET /v1/resourceowner/routeplanner/routes`

## Request

- Base URL: `https://api.automile.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.automile.com/v1/resourceowner/routeplanner/routes`
- Auth: OAuth 2
  - Implicit: `https://api.automile.com/login/`

Only routes that is either shared with the user or owned by the calling user is returned.
            <br /><br />
            Location Status enum values:<br />
            *NotStarted = 0*<br />
            *Done = 1*<br />
            *Cancelled = 3*<br /><br />
            MissionStatus enum values: <br />
            *Not Started = 0 (All route locations NotStarted)*<br />
            *Ongoing = 1 (Any route location Done OR route mission started)*<br />
            *Done = 2 (All route locations Done)*<br />
            *Cancelled = 3 (Route mission Cancelled)*

## Response `200`

The routes associated with the user is returned.

- RoutePlannerMissionModel[]
  - `DistanceInKilometers` number, double
  - `DurationInSeconds` number, double
  - `RouteId` integer
  - `Name` string
  - `ContactId` integer
  - `IsDeparture` boolean
  - `OccuredAt` string, date-time
  - `MissionStatus` 0 | 1 | 2 | 3
  - `RouteStartedAtUTC` string, date-time
  - `RouteStartedByContactId` integer
  - `RouteEndedAtUTC` string, date-time
  - `Notes` string
  - `CreatedUTC` string, date-time
  - `Locations` RoutePlannerMissionLocationModel[]
    - `DistanceInKilometers` number, double
    - `DurationInSeconds` number, double
    - `Address` string
    - `Note` string
    - `RouteStopId` integer
    - `Status` 0 | 1 | 3
    - `DriverNotes` string
    - `Latitude` number, double
    - `Longitude` number, double

---

[API](https://skmtc.dev/automile/apis/automile-api.md) - [All operations](https://skmtc.dev/automile/apis/automile-api/llms.txt) - [OpenAPI document](https://skmtc.dev/automile/apis/automile-api/revisions/56b5b8d6d733?raw)