---
title: "Get Routes"
method: GET
path: "/v1/Scheduling/routes"
tags: ["Scheduling"]
---

# Get Routes

`GET /v1/Scheduling/routes`

## Request

- Base URL: `https://example.com:443`
- URL: `https://example.com:443/v1/Scheduling/routes`
- Auth: none required
- TypeScript: <https://skmtc.dev/nayax/apis/nayax-cortina-api/docs/v1/Scheduling/routes/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of routes based on various query parameters, such as OperatorId, DriverId, Status, and multiple search options (e.g., by Name, Code, Notes, etc.).

## Query parameters

- `OperatorId` integer
- `DriverId` string, uuid
- `Status` integer
- `Search` string
- `SearchByName` boolean
- `SearchByCode` boolean
- `SearchByNotes` boolean
- `SearchByRouteId` boolean

## Response `200`

A list of routes that match the specified criteria.

- ActorRouteResponseDto[]
  - `DistributorId` integer: The unique identifier of the distributor associated with the routes.
  - `OperatorId` integer: The unique identifier of the operator associated with the routes.
  - `OperatorName` string, nullable: The name of the operator associated with the routes.
  - `ActorRoutes` RouteResponseDto[], nullable: A list of routes associated with the operator and distributor.
    - `RouteId` integer: The unique identifier of the route.
    - `DriverId` string, uuid, nullable: The unique identifier of the driver assigned to the route.
    - `DriverName` string, nullable: The name of the driver assigned to the route.
    - `DriverMobile` string, nullable: The mobile phone number of the driver assigned to the route.
    - `RouteName` string, nullable: The name of the route.
    - `RouteCode` string, nullable: The code used to identify the route.
    - `RouteRemarks` string, nullable: Additional remarks or notes related to the route.
    - `RouteStatusId` integer: The status identifier of the route, indicating its current status.
    - `RouteMachineCount` string, nullable: The number of machines assigned to the route.
    - `CreatedDt` string, date-time: The date and time when the route was created.
    - `CreatedBy` integer: The identifier of the user who created the route.
    - `UpdatedDt` string, date-time, nullable: The date and time when the route was last updated.
    - `UpdatedBy` integer, nullable: The identifier of the user who last updated the route.

---

[API](https://skmtc.dev/nayax/apis/nayax-cortina-api.md) - [All operations](https://skmtc.dev/nayax/apis/nayax-cortina-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nayax/apis/nayax-cortina-api/revisions/421f6f83c257?raw)