v1

latestOpenAPI 3.1.02026-07-2438302.6 MB

Get Routes

get/routes

Query parameters

pageinteger

countinteger

sort'DESC' | 'ASC'

sort_by'departure' | 'route_name'

get_past_routesboolean

for recurring route

send_polylineboolean

from_datestring date

to_datestring date

filter.keywordstring

filter.route_uidstring

filter.team_uidstring

filter.user_uidstring

filter.assignment_status'ASSIGNED' | 'UNASSIGNED'

filter.is_optimizedboolean

filter.recurring_route_uidstring

filter.skillset_uidstring

filter.is_recurrenceboolean

filter.is_lockedboolean

Response

200

typestring

total_recordsinteger

current_pageinteger

total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "created_by": {
        "user_uid": "1eb1d499-e8b1-4979-a04b-4b0599599529",
        "first_name": "Ashin",
        "last_name": "Thankachan",
        "email": "ashin.t@zuper.co",
        "designation": "Admin",
        "emp_code": "Z103",
        "work_phone_number": "8301907278",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/6c287db0-ff7c-11e7-b3a8-29b417a4f3fa/d26d3dd0-0c47-11ee-b705-491517420371.jpg",
        "hourly_labor_charge": 120,
        "is_active": true,
        "created_at": "2022-07-04T06:25:56.000Z",
        "updated_at": "2024-09-02T09:26:10.000Z",
        "role": {
          "role_id": 1,
          "role_uid": "504e4eac-ff7d-11e7-8be5-0ed5f89f718b",
          "role_name": "Admin",
          "role_key": "ADMIN",
          "created_at": "2018-01-22T00:00:00.000Z",
          "updated_at": "2018-01-22T00:00:00.000Z"
        }
      },
      "route_uid": "1dcde262-1de0-4d8d-bb93-27e93ff53d54",
      "route_name": "every-weekday-route-53",
      "duration": 8,
      "departure": "2024-09-19T14:00:00.000Z",
      "route_end_time": "2024-09-19T22:00:00.000Z",
      "route_type": "FASTEST",
      "transport_mode": "CAR",
      "color": "#e67e22",
      "start_location": {
        "name": "Chennai",
        "street": "Besant Nagar",
        "geo_cords": [
          13.0002927
        ]
      },
      "end_location": {
        "name": "Egattur",
        "street": "Old Mahabalipuram Road",
        "geo_cords": [
          12.8337782
        ],
        "distance": 21378,
        "time": 3025
      },
      "assigned_to": [
        {
          "user": {
            "user_uid": "f2f5bb37-cd1b-4864-92d7-1e59c493f0bd",
            "first_name": "Katrina",
            "last_name": "Whale",
            "email": "kat@gmail.com",
            "home_phone_number": "0988753484",
            "designation": "Field Executive",
            "emp_code": "1029",
            "work_phone_number": "0988753484",
            "profile_picture": "https://i.imgur.com/phnZHKE.png",
            "hourly_labor_charge": 20,
            "is_active": true,
            "created_at": "2018-06-11T17:07:23.000Z",
            "updated_at": "2024-09-04T04:15:47.000Z",
            "role": {
              "role_id": 3,
              "role_uid": "504e52bc-ff7d-11e7-8be5-0ed5f89f718b",
              "role_name": "Field Executive",
              "role_key": "FIELD_EXECUTIVE",
              "created_at": "2018-01-22T00:00:00.000Z",
              "updated_at": "2018-01-22T00:00:00.000Z"
            }
          },
          "team": {
            "team_uid": "9f620406-0a8c-430b-858d-ced59cef93a7",
            "team_name": "Sales Team",
            "team_color": "#4960a0",
            "is_active": true
          }
        }
      ],
      "recurring_route": {
        "recurring_route_uid": "7d70d884-90f9-40da-b763-8e118aa4e1a9",
        "recurring_route_name": "every-weekday-route",
        "repeat_frequency": "WEEKLY",
        "repeat_every": 1,
        "rrule": "DTSTART=20240709T043000Z;FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR;UNTIL=20240930T182900Z"
      },
      "is_recurrence": true,
      "created_at": "2024-07-08T06:59:00.193Z",
      "updated_at": "2024-07-08T06:59:03.533Z",
      "__v": 1,
      "total_distance": 21378,
      "total_time": 3025,
      "overall_duration": 3025
    }
  ],
  "total_records": 1,
  "current_page": 1,
  "total_pages": 1
}