> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usenash.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Routes

> List and search routes with filters and pagination.

Use this to find routes — by date, status, driver, or free-text search — when you have no route ID to start from. The payload is deliberately slim: enough to identify a route and show it in a list, not the whole plan. Read [Get Route](/api-reference/route/get-route) once you know which one you want.

`startDate` defaults to 30 days ago, so a call with no date range returns the recent past rather than everything you have ever run.


## OpenAPI

````yaml get /v1/routes
openapi: 3.1.0
info:
  title: Nash API
  version: 1.0.0
servers:
  - url: https://api.sandbox.usenash.com
    description: Sandbox API
  - url: https://api.sandbox.ap-southeast-2.usenash.com
    description: Sandbox API (Australia)
  - url: https://api.usenash.com
    description: Production API
  - url: https://api.ap-southeast-2.usenash.com
    description: Production API (Australia)
security: []
tags:
  - name: Notifications
    description: Notifications
    x-nash-topic: config
  - name: Annotate
    description: Annotate
    x-nash-topic: wismo
  - name: Notifications — Send
    description: One-off notification send without a NotificationTrigger.
    x-nash-topic: notifications
  - name: Shipping
    description: Shipping operations
    x-nash-topic: shipping
  - name: Workflow
    description: Workflow automation management
    x-nash-topic: scheduling
  - name: Workflow Execution
    description: Workflow execution history and monitoring
    x-nash-topic: scheduling
  - name: Optimization Strategies
    description: Create, read, update, and delete route optimization strategies.
    x-nash-topic: scheduling
  - name: AI Agents
    description: AI agent management — create, read, update, and delete agents
    x-nash-topic: config
  - name: AI Functions
    description: LLM-backed domain tools
    x-nash-topic: ai
  - name: Webhooks
    description: Webhook delivery inspection
    x-nash-topic: webhooks
  - name: Miscellaneous
    description: Miscellaneous
  - name: Job
    description: Job
    x-nash-topic: wismo
  - name: Batch Job
    description: Batch Job
    x-nash-topic: wismo
  - name: Order
    description: Order
    x-nash-topic: wismo
  - name: Provider
    description: Provider
    x-nash-topic: provider
  - name: Dispatch Strategies
    description: Dispatch Strategies
    x-nash-topic: scheduling
  - name: Store Locations
    description: Store Locations
    x-nash-topic: config
  - name: Vehicles
    description: Vehicles
    x-nash-topic: provider
  - name: Couriers
    description: Couriers
    x-nash-topic: provider
  - name: Shifts
    description: Shifts
    x-nash-topic: provider
  - name: Delivery Windows
    description: Delivery Windows
    x-nash-topic: config
  - name: Templates
    description: Templates
    x-nash-topic: config
  - name: Zones
    description: Zones
    x-nash-topic: config
  - name: Feedback
    description: Feedback
    x-nash-topic: reporting
  - name: Organizations
    description: Organizations
    x-nash-topic: config
  - name: Store Catalog
    description: Store Catalog
    x-nash-topic: config
  - name: Route
    description: Route
    x-nash-topic: scheduling
  - name: Messaging
    description: Messaging
    x-nash-topic: config
  - name: Billing
    description: Invoice-aligned customer billing usage
    x-nash-topic: config
  - name: Contracts
    description: Provider contract pricing and version listings
    x-nash-topic: provider
  - name: Fleet
    description: Inbound endpoints fleets call to manage their drivers.
    x-nash-topic: driver
  - name: Embed Sessions
    description: >-
      Mint short-lived, browser-safe sessions for embedded Nash Widgets.
      Authenticated with an org embed credential, which must stay on your
      backend.
    x-nash-topic: config
  - name: Event Timeline
    description: Entity-scoped event timeline + outbound provider traffic for one entity.
    x-nash-topic: internal
  - name: Inventory
    description: Store inventory catalog sync to SFTP retail destinations (e.g. Uber).
    x-nash-topic: store_catalog
  - name: Route Restrictions
    description: Org-scoped geographic areas the route optimizer must avoid traversing.
    x-nash-topic: config
  - name: Users
    description: User, role, and organization-membership management.
    x-nash-topic: config
  - name: Widgets
    description: >-
      Org configuration for embedded Nash Widgets: parent origins, enablement,
      and embed credentials.
    x-nash-topic: config
  - name: Provider Chat
    description: Carrier-chat context for a route, scoped to the caller's organization.
    x-nash-topic: internal
paths:
  /v1/routes:
    get:
      tags:
        - Route
      summary: List/Search Routes
      description: >-
        List routes with filters and pagination. Returns a slim payload suitable
        for discovery; use GET /v1/routes/<id> for full details.
      operationId: routes_v1_list_routes_routes_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            title: Limit
            maximum: 100
            minimum: 1
            type: integer
            default: 25
            example: 25
          example: 25
        - name: offset
          in: query
          required: false
          schema:
            title: Offset
            minimum: 0
            type: integer
            default: 0
            example: 0
          example: 0
        - name: sortDirection
          in: query
          description: ASC or DESC, applied to created_at
          required: false
          schema:
            title: Sortdirection
            type: string
            description: ASC or DESC, applied to created_at
            default: DESC
        - name: startDate
          in: query
          description: Defaults to 30 days ago.
          required: false
          schema:
            title: Startdate
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: Defaults to 30 days ago.
            default: null
        - name: endDate
          in: query
          description: Defaults to now.
          required: false
          schema:
            title: Enddate
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: Defaults to now.
            default: null
        - name: tags
          in: query
          description: >-
            Comma-separated order tags; matches routes with an order carrying
            any of them
          required: false
          schema:
            title: Tags
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Comma-separated order tags; matches routes with an order carrying
              any of them
            default: null
        - name: search
          in: query
          description: Free-form search
          required: false
          schema:
            title: Search
            anyOf:
              - type: string
              - type: 'null'
            description: Free-form search
            default: null
        - name: isDispatched
          in: query
          description: Filter by dispatched state
          required: false
          schema:
            title: Isdispatched
            anyOf:
              - type: boolean
              - type: 'null'
            description: Filter by dispatched state
            default: null
        - name: dispatchStrategyId
          in: query
          description: Comma-separated
          required: false
          schema:
            title: Dispatchstrategyid
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated
            default: null
        - name: pickupStoreLocationIds
          in: query
          description: Comma-separated
          required: false
          schema:
            title: Pickupstorelocationids
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated
            default: null
        - name: dropoffStoreLocationIds
          in: query
          description: Comma-separated
          required: false
          schema:
            title: Dropoffstorelocationids
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated
            default: null
        - name: city
          in: query
          description: Comma-separated pickup/dropoff cities
          required: false
          schema:
            title: City
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated pickup/dropoff cities
            default: null
        - name: state
          in: query
          description: Comma-separated pickup/dropoff states
          required: false
          schema:
            title: State
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated pickup/dropoff states
            default: null
        - name: country
          in: query
          description: Comma-separated pickup/dropoff countries
          required: false
          schema:
            title: Country
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated pickup/dropoff countries
            default: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutesListResponse'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NashValidationError'
components:
  schemas:
    RoutesListResponse:
      title: RoutesListResponse
      required:
        - results
        - totalCount
        - limit
        - offset
      type: object
      properties:
        results:
          title: Results
          type: array
          items:
            $ref: '#/components/schemas/RouteListItem'
        totalCount:
          title: Totalcount
          type: integer
        limit:
          title: Limit
          type: integer
        offset:
          title: Offset
          type: integer
    NashValidationError:
      title: NashValidationError
      required:
        - error
        - response_status
        - RequestID
      type: object
      properties:
        error:
          $ref: '#/components/schemas/NashErrorDetails'
        response_status:
          title: Response Status
          type: string
        RequestID:
          title: Requestid
          type: string
    RouteListItem:
      title: RouteListItem
      required:
        - id
      type: object
      properties:
        id:
          title: Id
          type: string
        externalId:
          title: Externalid
          anyOf:
            - type: string
            - type: 'null'
          default: null
        name:
          title: Name
          anyOf:
            - type: string
            - type: 'null'
          default: null
        status:
          title: Status
          anyOf:
            - type: string
            - type: 'null'
          default: null
        createdAt:
          title: Createdat
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
        updatedAt:
          title: Updatedat
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          default: null
        portalUrl:
          title: Portalurl
          anyOf:
            - type: string
            - type: 'null'
          default: null
        providerName:
          title: Providername
          anyOf:
            - type: string
            - type: 'null'
          default: null
        courier:
          anyOf:
            - $ref: '#/components/schemas/RouteCourierSummary'
            - type: 'null'
          default: null
        vehicle:
          anyOf:
            - $ref: '#/components/schemas/RouteVehicleSummary'
            - type: 'null'
          default: null
        stopCount:
          title: Stopcount
          anyOf:
            - type: integer
            - type: 'null'
          default: null
        orderIds:
          title: Orderids
          anyOf:
            - type: array
              items:
                type: string
            - type: 'null'
          default: null
        distanceMeters:
          title: Distancemeters
          anyOf:
            - type: integer
            - type: 'null'
          default: null
        durationSeconds:
          title: Durationseconds
          anyOf:
            - type: integer
            - type: 'null'
          default: null
    NashErrorDetails:
      title: NashErrorDetails
      required:
        - code
        - message
      type: object
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
        details:
          title: Details
          anyOf:
            - type: object
              additionalProperties: true
            - type: 'null'
          description: >-
            Structured error context; shape depends on `code`. For
            `VALIDATION_ERRORS` (HTTP 422) it is `{"fields": [{"loc": [...],
            "msg": "...", "type": "..."}]}` — one entry per invalid field, where
            `loc` is the field path, `msg` the human-readable message, and
            `type` the machine-readable error type (e.g. `string_type`,
            `missing`).
          default: null
    RouteCourierSummary:
      title: RouteCourierSummary
      type: object
      properties:
        id:
          title: Id
          anyOf:
            - type: string
            - type: 'null'
          default: null
        name:
          title: Name
          anyOf:
            - type: string
            - type: 'null'
          default: null
    RouteVehicleSummary:
      title: RouteVehicleSummary
      type: object
      properties:
        id:
          title: Id
          anyOf:
            - type: string
            - type: 'null'
          default: null
        name:
          title: Name
          anyOf:
            - type: string
            - type: 'null'
          default: null

````