---
title: "Get Recurring Routes"
method: GET
path: "/routes/recurring"
---

# Get Recurring Routes

`GET /routes/recurring`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/routes/recurring`
- Auth: API key in header `x-api-key`

## Query parameters

- `page` integer
- `count` integer
- `sort` 'DESC' | 'ASC'
- `sort_by` 'created_at' | 'recurring_route_name'
- `filter.keyword` string
- `filter.assigned_to` string
- `filter.created_by` string
- `filter.from_date` string, date
- `filter.to_date` string, date
- `filter.recurring_jobs_uid` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `recurring_route_uid` string
    - `recurring_route_name` string
    - `recurring_route_description` string
    - `duration` object
      - `value` integer
      - `type` string
    - `repeat_frequency` string
    - `repeat_on` object
      - `byweekday` object[]
        - `weekday` integer
        - `n` unknown
      - `bymonth` unknown[]
        - unknown
      - `bymonthday` unknown[]
        - unknown
    - `rrule` string
    - `total_routes` integer
    - `route_duration` integer
    - `route_start` string
    - `route_end` string
    - `route_type` string
    - `transport_mode` string
    - `enable_traffic` boolean
    - `color` string
    - `start_location` object
      - `name` string
      - `street` string
      - `geo_cords` number[]
    - `end_location` object
      - `name` string
      - `street` string
      - `geo_cords` number[]
      - `distance` integer
      - `time` integer
    - `assigned_to` object[]
      - `user` object
        - `user_uid` string
        - `first_name` string
        - `last_name` string
        - `email` string
        - `external_login_id` unknown
        - `home_phone_number` string
        - `designation` string
        - `emp_code` string
        - `prefix` unknown
        - `work_phone_number` string
        - `mobile_phone_number` unknown
        - `profile_picture` string
        - `hourly_labor_charge` number
        - `is_active` boolean
        - `is_deleted` boolean
        - `created_at` string
        - `updated_at` string
        - `role` object
          - `role_name` string
          - `role_key` string
      - `team` object
        - `team_uid` string
        - `team_name` string
        - `team_color` string
        - `is_active` boolean
        - `is_deleted` boolean
    - `is_active` boolean
    - `is_deleted` boolean
    - `created_by` object
      - `user_uid` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `external_login_id` unknown
      - `home_phone_number` unknown
      - `designation` string
      - `emp_code` string
      - `prefix` unknown
      - `work_phone_number` string
      - `mobile_phone_number` unknown
      - `profile_picture` string
      - `hourly_labor_charge` integer
      - `is_active` boolean
      - `is_deleted` boolean
      - `created_at` string
      - `updated_at` string
      - `role` object
        - `role_name` string
        - `role_key` string
    - `recurring_jobs` object[]
      - `recurring_job` object
        - `recurring_job_uid` string
        - `job_title` string
    - `total_distance` integer
    - `total_time` integer
    - `id` string
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/routes/recurring/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)
