Skip to main content

Method

GET /v1/ref/transportation-modes

Description

Returns the complete list of active transportation modes available in the platform. This includes modes like flight, train, bus, car, ferry, and others used for product configuration and booking workflows.

Headers

This endpoint is public and does not require authentication.

Query Parameters

No query parameters are required. The endpoint returns all active transportation modes sorted by displayOrder and then by name.

Response

{
  "items": [
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "code": "flight",
      "name": "Flight",
      "description": "Air travel",
      "displayOrder": 1,
      "isActive": true,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    },
    {
      "id": "01234567-89ab-cdef-0123-456789abcdef",
      "code": "train",
      "name": "Train",
      "description": "Rail travel",
      "displayOrder": 2,
      "isActive": true,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Response Fields

items
array
required
Array of transportation mode objects.
items[].id
string
required
UUID v7 identifier for the transportation mode.
items[].code
string
required
Unique code identifier (e.g., “flight”, “train”, “bus”).
items[].name
string
required
Human-readable name of the transportation mode.
items[].description
string
Optional description of the transportation mode.
items[].displayOrder
number
Order for display purposes (lower numbers appear first).
items[].isActive
boolean
required
Whether the transportation mode is currently active.
items[].createdAt
string
required
ISO 8601 timestamp of when the record was created.
items[].updatedAt
string
required
ISO 8601 timestamp of when the record was last updated.

Notes

  • Only active transportation modes (isActive: true) are returned
  • Results are sorted by displayOrder (ascending), then by name (ascending)
  • Inactive or soft-deleted modes are excluded from this endpoint