Reten Docs
Routes

List Routes

Get a paginated list of routes.

GET /api/routes

Returns a paginated list of routes with optional filters.

Auth: Required — MANAGE_ROUTES permission

Query Parameters

ParameterTypeDefaultDescription
pagenumber1Page number
per_pagenumber25Items per page (max 100)
searchstring-Search by name or code
is_activeboolean-Filter by active status

Example

curl "https://api.reten.ai/api/routes?page=1&limit=10" \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
import axios from 'axios';

const response = await axios.get(
  'https://api.reten.ai/api/routes',
  {
    params: {
      page: 1,
      limit: 10,
    },
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Response 200 OK

{
  "data": [
    {
      "id": "dd0e8400-e29b-41d4-a716-446655440000",
      "name": "North Zone",
      "code": "ZONE-NORTH",
      "isActive": true
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1
  }
}