Get reservations

Returns paginated reservations table data. Times are unix seconds; distances are in kilometers.

GET/reservations

Query Parameters

Parameter	Type	Required	Description
`sort`	string	No	Sort by field:asc/desc Allowed: asc, desc
`fromDate`	number	No	Start date filter (unix seconds)
`toDate`	number	No	End date filter (unix seconds)
`suppliers`	string[]	No	Supplier ids filter
`profiles`	string[]	No	Profile ids filter
`status`	string[]	No	Reservation statuses filter
`groupId`	string	No	Group id filter
`waitAndReturnId`	string	No	Wait-and-return id filter
`attributes`	string[]	No	Attribute ids filter
`drivers`	string[]	No	Driver ids filter
`vehicles`	string[]	No	Vehicle ids filter
`from`	string[]	No	Search by origin names
`to`	string[]	No	Search by destination names
`isGrouped`	boolean	No	Filter grouped reservations only
`isWaitAndReturn`	boolean	No	Filter wait-and-return reservations
`isRoundTrip`	boolean	No	Filter round-trip reservations
`isDropDate`	boolean	No	Filter drop-date based reservations
`areas`	string[]	No	Area ids filter
`limit`	number	Yes	-
`page`	number	Yes	-
`search`	string	No	-

Example Response

{
  "page": 1,
  "limit": 20,
  "totalPages": 1,
  "totalResults": 2,
  "records": [
    {
      "id": 101,
      "type": "normal",
      "date": 1700000000,
      "dateType": "pick",
      "status": "new",
      "fromAddress": {
        "name": "Airport",
        "lat": 32,
        "lng": 34.8
      },
      "toAddress": {
        "name": "Hotel",
        "lat": 32.08,
        "lng": 34.78
      },
      "seats": 1,
      "attributes": [
        "Wheelchair"
      ],
      "supplierId": 2,
      "serviceId": 5,
      "tripId": 5001,
      "profile": "Corporate",
      "email": "passenger@example.com",
      "phone": "+15551234567",
      "passengerLabel": "John Doe",
      "externalId": "RES-101",
      "inAndOut": 0,
      "roundTrip": false,
      "extendUntilDate": 1700000600,
      "tags": [
        {
          "key": "priority",
          "value": "medical"
        }
      ],
      "labels": [
        {
          "key": "category",
          "value": "vip",
          "type": "important"
        }
      ],
      "areas": [
        "Center"
      ],
      "distance": 14.2,
      "duration": 900,
      "price": 45.75
    },
    {
      "id": 102,
      "type": "shuttle",
      "date": 1700010000,
      "dateType": "pick",
      "status": "canceled",
      "fromAddress": {
        "name": "Stop A",
        "lat": 32.1,
        "lng": 34.82
      },
      "toAddress": {
        "name": "Stop B",
        "lat": 32.11,
        "lng": 34.83
      },
      "seats": 2,
      "attributes": [],
      "email": "jane@example.com",
      "phone": "+15559876543",
      "shuttleLine": "Blue",
      "shuttleDirection": "eastbound",
      "shuttleProfile": "Morning",
      "areas": [
        "North"
      ]
    }
  ]
}

Query Parameters

Example Response

On this page