---
title: "Search routes"
method: GET
path: "/routes"
tags: ["Routes"]
---

# Search routes

`GET /routes`

Search payment routes.

## Query parameters

- `route_id` string
- `route_name` string
- `route_type_id` integer
- `route_active` boolean
- `with` 'route_merchants'
- `limit` integer
- `offset` integer
- `sort_by` string
- `order` 'asc' | 'desc'

## Response `200`

OK

- object
  - `total` string
  - `routes` object[]
    - `route_id` integer
    - `route_name` string
    - `route_type_id` 1 | 2 | 3 — * `1` - Round Robin * `2` - Volume * `3` - Weight
    - `route_include_decline` boolean
    - `route_force_items` boolean
    - `merchant_auto_active` boolean
    - `merchant_auto_active_count` integer
    - `route_active` boolean
    - `route_notes` string
    - `date_created` string, date-time
    - `created_by` integer
    - `date_modified` string, date-time
    - `modified_by` integer
    - `route_merchants` object[]
      - `merchant_id` integer
      - `merchant_name` string
      - `route_merchant_active` boolean

## Other responses

- `401` — Unauthorized response
- `403` — Forbidden response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/versions/62037010356e/schema)