GET /bookings
Api key Secret key

get booking list

Query parameters

  • vehicle_id integer
  • status string

    Référence de la location

    Values are waiting, confirm, check-in, check-out, or cancel.

  • reference string

    Référence de la location

  • customer_name string

    Nom ou prénom du client

  • vehicle_registration_number string

    Plaque d'immatriculation du véhicule

  • limit integer

    Nombre maximum de résultat par page

  • page integer

    Numéro de la page à afficher

  • min_start_date string

    Date: YYYY-MM-DD HH:mm

  • max_start_date string

    Date: YYYY-MM-DD HH:mm

  • min_end_date string

    Date: YYYY-MM-DD HH:mm

  • max_end_date string

    Date: YYYY-MM-DD HH:mm

  • min_creation_date string

    Date: YYYY-MM-DD HH:mm

  • max_creation_date string

    Date: YYYY-MM-DD HH:mm

  • min_update_date string

    Date: YYYY-MM-DD HH:mm

  • max_update_date string

    Date: YYYY-MM-DD HH:mm

Responses

  • 200 application/json

    200 response

    Hide response attributes Show response attributes object
    • paginationNumber integer
    • paginationOffset integer
    • total integer
    • numberPage integer
    • list array[object]
      Hide list attributes Show list attributes object
      • id integer
      • start_date string
      • end_date string
      • reference string
      • vehicle object
        Hide vehicle attributes Show vehicle attributes object
        • id integer
        • registration_year integer
        • registration_number string
        • brand string
        • model string
        • category object
          Hide category attributes Show category attributes object
          • id integer
          • name string
        • prices array[object]
          Hide prices attributes Show prices attributes object
          • min_days integer
          • max_days integer
          • high_season number
          • medium_season number
          • low_season number
        • booking_amount integer
        • mileage_levels array[object]
          Hide mileage_levels attributes Show mileage_levels attributes object
          • id integer
          • mileage number
          • is_default boolean
          • amount number
          • unlimited boolean
          • included_in_booking boolean
      • nb_days number
      • status string
      • total_amount number
GET /bookings 
curl \
 --request GET 'https://api.fleetee.io/bookings' \
 --header "x-api-key: $API_KEY"
Response examples (200) 
{
  "paginationNumber": 42,
  "paginationOffset": 42,
  "total": 42,
  "numberPage": 42,
  "list": [
    {
      "id": 42,
      "start_date": "string",
      "end_date": "string",
      "reference": "string",
      "vehicle": {
        "id": 42,
        "registration_year": 42,
        "registration_number": "string",
        "brand": "string",
        "model": "string",
        "category": {
          "id": 42,
          "name": "string"
        },
        "prices": [
          {
            "min_days": 42,
            "max_days": 42,
            "high_season": 42.0,
            "medium_season": 42.0,
            "low_season": 42.0
          }
        ],
        "booking_amount": 42,
        "mileage_levels": [
          {
            "id": 42,
            "mileage": 42.0,
            "is_default": true,
            "amount": 42.0,
            "unlimited": true,
            "included_in_booking": true
          }
        ]
      },
      "nb_days": 42.0,
      "status": "string",
      "total_amount": 42.0
    }
  ]
}