public-api-docs

Changelog

2026-05-29

• Operations API: Add new Device Operations API (available as value-added service)

2026-05-28

• Document api-client sign-in token behavior in OpenAPI

2026-05-28

• User API: Add maxStateOfCharge filter to GET /vehicles endpoint

2026-05-28

• Operations API: Added /booking-stations/{bookingStationId}/capacity-forecast endpoint to expose station capacity forecast.

2026-05-27

• Operations API: Added SmokeDetected and SmokeDataReady information to events

2026-05-22

• Operations API: Added /back/vehicles/open-tasks-overview endpoint to expose open tasks overview across all vehicles.
• Operations API: Added /back/vehicles/open-damages-overview endpoint to expose open damages overview across all vehicles.

2026-05-20

• Operations API: Added excludeBookingId request parameter to /back/bookings/available-categories endpoint, to support booking edit flow.
• Operations API: Added searchText filter to back/groups/{id}/members endpoint

2026-05-18

• Operations API: Removed intersectable branches setting type

2026-05-13

• Users API: Fetch rental with sql level lock on rental row before perfo…
• Operations API: Added GET /bookings/bookable-categories endpoint
• Operations API: Added GET bookings/available-categories endpoint

2026-05-07

• Users API: expose freeMinutes fields for front voucher endpoints
• Operations API: Add remainingMinutesValue to UserDetails.Statistics
• Operations API: Added GET /booking-stations/{bookingStationId}/vehicles endpoint.

2026-05-06

• User API: The includeWithPricingOnly query parameter now defaults to true (previously false). Categories without pricing configured are excluded by default.
• User API: New includeWithRentalRequirementsOnly query parameter (boolean, defaults to true) that filters results to only categories with rental requirements configured.

2026-05-05

• Operations API: Add annotations to Bookings

2026-04-30

• Operations API: Add new Benefit objects and multi-benefit related changes to the Voucherables endpoints.
• Users API: Add new POST /vouchers/redeem-code endpoint to redeem multi-benefit voucherable codes. Added missing applicablePriceType field to ConstraintVoucher.

2026-04-28

• Users API: Add acceptTnc field for email and phone otp flows

2026-04-22

• Operations API: expose refundedInvoice object in case of refund invoice

2026-04-20

• Operations API: Mark openTasks and openDamages as deprecated in VehicleList.
• Users API: Add contactInfo to response body of GET /front/branches/{id}/intersectable endpoint.

2026-04-17

• Operations API: expose state field for operator on users/subscriptions endpoint
• Users API: Add new endpoints for new subscription flow

2026-04-17

• Operations API: Enforce max group memberships when adding members via backend, add endpoint to add a single member to group.

2026-04-16

• Operations API: Document startTime query parameter, and clarify intersectTime behavior for the GET /rentals endpoint

2026-04-16

• Operations API: Expose endPosition, endAddress, endKilometers, distance, and rentalTimes for ENDED_NO_MOVEMENT rentals

2026-04-15

• Operations API: Document versionInfo in VehicleTelemetry spec

2026-04-13

• Users API: add subscription state support
• Operations API: add subscription state support

2026-04-07

• Operations API: Disallow approval of damages without severity (error code 406)

2026-04-03

• Operations API: Add searchText quey parameter to GET /iot-modules endpoint

2026-04-02

• Operations API: treat -1 as null to allow clearing station capacity on PATCH

2026-03-27

• Operations API: Add task categories
• User API: Add task categories
• Webhooks API: Add task categories

2026-03-26

• Users API: Add parking spot note at the end of rental
• Users API: move search logic into generic station get endpoint

2026-03-24

• Remove Early Pickup Penalty functionality.

2026-03-18

• User API: Add station search endpoint

2026-03-17

• User API: Parking reservation for on demand rentals

2026-03-12

• User API: updated request and response schema of various endpoints.

2026-03-12

• User API: Add /rentals/{id}/damages endpoint
• Operations API: Add “HIGH” damage severity
• User API: Add “HIGH” damage severity
• Operations API: Deprecate /booking-stations/{bookingStationId}/check-booking-creation-availability endpoint

2026-03-11

• Operations API: Add hasRatingDescription filter to /bookings endpoint
• Operations API: Allow safe replacement of IoT Modules

2026-03-10

• Operations API: Add cancelBenefits option to subscription cancel endpoint

2026-03-06

• Operations API: Add new query parameters to GET rentals/additions and GET additions-management endpoints

2026-03-05

• Operations API: Return latest invoice ID in GET /back/user-subscriptions

2026-03-03

• Webhooks: added task created webhooks

2026-03-02

• Operations API: Fix bug in deleting payment source of user group (business account) by admin

2026-02-26

• Operations API: Add excludeDecommissionedVehicles query parameter to the /vehicles endpoint.
• Operations API: Deprecate excludeRetiredVehicles query parameter in the /vehicles endpoint.

2026-02-25

• User API: Add POST /rentals/{rentalId}/files endpoint to link files to rentals in RESERVATION or ACTIVE state

2026-02-23

• Operations API: Expose list of open damages (openDamages array) in Vehicle List DTO
• Operations API: add ability to send accountId and vehicleId at the same time

2026-02-22

• Operations API: Expose list of open tasks (openTasks array) to Vehicle List DTO and deprecate openTasksCount

2026-02-20

• Moving the Voucherable validation to the Activation endpoint
• Operations API: Expose failedEndRentalRequirements for event RENTAL_END_CHECK

2026-02-19

• Remove /back/about and /back/uptime/databaseTime endpoints

2026-02-10

• User API: Filter vehicles by battery level (soc)

2026-02-05

• Operations API: Expose openingInformation and timeZoneId in list booking stations endpoint

2026-02-02

• Operations API: Add lifetimeValue and remainingVoucherValueGross fields to customer details endpoint

2026-01-26

• Operations API: expose isAccountAllowedToRent in user details response

2026-01-26

• Operations API: Vehicle bulk endpoints for tasks, notes and tags

2026-01-23

• Operations API: link files to tasks

2026-01-22

• Operations API: Expose new endpoint for vehicles bulk update by vehicle IDs

2026-01-16

• Webhooks: added task status update webhooks
• Operations API: Add branchId and includeChildBranches request parameters to KPIs endpoint

2026-01-14

• Operations API: Add information on rentals about beginner ride mode
• User API: Add beginner ride mode option on rental start

2025-12-26

• Operations API: Add all possible values to KpiType schema.

2025-12-25

• Operations API: Additional task categories (DAMAGE, ACCESS_AND_TELEMATICS, VEHICLE_FAULT, REGULATORY_AND_COMPLIANCE, BILLING_AND_CUSTOMER_CHARGE, ADMINISTRATIVE)
• Operations API: Link Damages to Issue

2025-12-19

• MaaS API: Add VERIFIED_BUT_NEEDS_CHECK value to verificationState

2025-12-18

• Operations API: Adding owner property to issue

2025-12-18

• Operations API: add detailed battery information to vehicle logs

2025-12-16

• All APIs: Extend vehicle service states - added regulatory and service-related statuses

2025-12-15

• Operations API: Add /kpis endpoint.
• User API: Add /rentals list endpoint.

2025-12-12

• Operations API: Add rating field to JsonRental schema.

2025-12-09

• Operations API: Add signupSettled query parameter to /customers endpoint.

2025-12-09

• Operations API: Add includeChildBranches query parameter to /areas endpoint.

2025-12-08

• User API: include internal addition if bookingId is passed in estimation

2025-11-27

• Webhooks: extended payload for invoice created (INVOICE_CREATED) and invoice refunded (INVOICE_REFUNDED) webhooks

2025-11-26

• Operations API: add ThoughtSpot trusted authentication endpoint
• Operations API: add endpoint to create bluetooth tokens for service workers

2025-11-20

• Operations API: Add VEHICLE_CHARGING_RESTRICTION_IGNORED enum value to Event schema

2025-11-19

• Operations API: Introduce a new benefit type for addition entitlement for voucherables and vouchers

2025-11-18

• Moved documents from knowledge base to API documentation

2025-11-18

• User API: Add missing terms and condition lookup endpoint

2025-11-17

• Operations API: Add searchText param to GET /tasks endpoint

2025-11-14

• Operations API: add pricing bundle endpoints and models in api docs- BUS-659: add pricing bundle endpoints and models in api docs

2025-11-13

• Operations API: Add searchText param to GET /damages endpoint

2025-11-11

• Operations API: Improve vehicles/execute-command documentation

2025-11-04

• Operations API: Add VehicleRentalUnavailabilityReason.

2025-11-03

• Operations API: Add ignoredRentalBlockers to VehicleListDTO.

2025-10-30

• Operations API: filter and validate additions for user and group if exists

2025-10-24

• Operations API: Add /back/additions-management endpoints for managing additions

2025-10-23

• Operations API: Add endpoint to mark invoice as LOST

2025-10-21

• Operations API: Add possibility to update Custom Tags on User Groups / Business Accounts.

2025-10-17

• Operations API: Introduced /back/business-units endpoints. Deprecated /back/revenue-centers endpoints.

2025-10-10

• Operations API: Add new vehicle service states.

2025-10-07

• Operations API: Expose pricing bundle version info in get booking by id endpoint.

2025-10-02

• Operations API: Added endpoint for calculating cooldowns (GET bookings/cooldowns).

2025-09-30

• MaaS API: Added endpoint for submission of document verifications (POST customers/{impersonationId}/verifications).

2025-09-11

• Operations API: Remove ‘PATCH verification/{verificationId}’ endpoint
• Operations API: Introduced isIncoming and isOutgoing in compatible branches endpoint, to indicate compatibility directions. Removed isCrossCompatible field.

2025-09-04

• Operations API: Add text search by Id in Rental endpoint
• Operations API: Add text search by id in Customer endpoint

2025-08-21

• Operations API: Add CORRECTION issue category
• User API: Remove includeWithPricingOnly parameter from GET /bookings/bookable-categories endpoint

2025-08-20

• Operations API: Fixed documentation of PUT vehicles/{id}/tags
• Operations API: Add Shared Booking settings

2025-08-19

• Operations API: Add cooldown data to BookingListDTO

2025-08-15

• Operations API: Add endpoint for retrieving compatible branches and endpoint for updating compatible branches

2025-08-14

• User API: Support for booking requests during booking creation

2025-08-11

• User API: Added endpoint to list bookable vehicle categories on a branch

2025-08-08

• Operations API: Allow filtering of bookings based on directions relative to the branch

2025-08-07

• Endpoint to retrieve Qlik access token- DATA-19 - Qlik Service, Controller and models

2025-08-05

• Operations API: Add startStationCooldown and endStationCooldown fields to Booking.
• Operations API: Extend GUser to contain drivingLicenseCategoryObject.

2025-08-04

• Operations API: add costSources property when creating voucherables

2025-08-01

• Operations API: Allow operator to change booking return station before and during a rental

2025-07-31

• User API: added endpoint to generate separate BLE tokens for park/drive and starting/ending a rental
• Operations API: Fix documentation for CSV import of translations

2025-07-30

• Webhooks: Added issue category to IssueCreated webhook

2025-07-25

• Operations API: Add onlyOverdueBookings filter to GET /bookings endpoint.

2025-07-24

• Operations API: Expand user details on VehicleActivityLog

2025-07-14

• Operations API: Add type field to voucherables endpoints

2025-07-09

• Operations API: Add priceGrossRaw and sumGrossRaw to RentalListDTO

2025-07-04

• Operations API: User subscriptions management new endpoints

2025-07-02

• Operations API: expose endpoint to fetch minute balance as well as monetary balance

2025-07-01

• User API: Endpoint to check requirement and surcharges at end of rental

2025-06-27

• Operations API: deprecate area parameter when adding a language

2025-06-25

• Operations API: Updated enum values of entityType

2025-06-23

• Operations API: Implement operator api to query subscriptions.

2025-06-17

• Operations API: FT-1139 Validate firstname and lastname.
• User API: FT-1139 Validate firstname and lastname.

2025-06-13

• [PLAT-1484] Record and Expose Cancellation date of Vouchers

2025-06-12

• Operations API: Add possibility to upload CSV with translations

2025-06-06

• User API: Add endBranchId to BookingUpdateRequest

2025-05-26

• Operations API: Add shouldIgnoreBCategoryRentalRequirement to user group settings
• Operations API: Add endpoint for update of driving license’s vehicle category obtainment date

2025-05-21

• User API: Add driving license’s vehicle categories to VerificationAttempt schema
• Operations API: Add driving license’s vehicle categories to VerificationAttempt schema

2025-05-20

• Operations API: add monetary field to ConstraintVoucherable and CreateVouchers

2025-05-16

• User API: Add Appsflyer support
• User API: setup Appsflyer server-2-server communication

2025-04-28

• Operations API, MaaS API: add CarLockState and IoT SoC to Vehicle

2025-04-25

• User API: Include PriceV3 and PriceV4 into Rental response
• Operations API: Include PriceV3 and PriceV4 into Rental response
• User API: Removed taxPercentage field from PriceDetails

2025-04-24

• User API: allow patching file IDs on ended rentals to upload photos etc after the rental

2025-04-22

• MaaS API: Added endpoint to retrieve MaaS Rental by ID

2025-04-02

• User API: Renamed LicenseVerificationState to DocumentVerificationState
• Operations API: Renamed LicenseVerificationState to DocumentVerificationState

2025-03-31

• User API: Added support for email OTP
• Operations API: Enable Email OTP for customer

2025-03-28

• Authentication: Added support for email OTP

2025-03-27

• Operations API: Update issue documentation

2025-03-26

• Operations API: Decrease minimum character length of firstName and lastName from 2 to 1, on user update endpoint.
• User API: Endpoint to request signed user data

2025-03-24

• Operations API: Add min amount of trips start rental requirement
• User API: Add min amount of trips start rental requirement

2025-03-13

• Extract licenseVerificationState into its own schema
• Notification channels endpoints

2025-03-10

• Operations API: Added ID Verification field to Customer List DTO

2025-03-03

• Operations API: Add support for ID verification (verification of any type of user’s personal documents)
• User API: Add support for ID verification (verification of any type of user’s personal documents)

2025-02-21

• Operations API: Support vehicle bulk creation with modules

2025-02-19

• Operations API: Added vehicle creation with module

2025-02-17

• User API: Deprecate the slots field, and expose station slots and parking area availability under a common availability field
• Operator API: CRUD API for station parking areas and new VEHICLE_IN_STATION_AREA rental end requirement. Deprecate the occupancy field, and expose new slots details and parking area details fields

2025-02-15

• User API: Add customExternalVerificationState to user
• Operator API: Add customExternalVerificationState to user

2025-02-14

• MaaS API: Expose booking id and rental id in invoice line item

2025-02-13

• Operator API: Manual credit rating of users

2025-02-12

• Added DEFLEETED as Vehicle Service State V2

2025-02-07

• Operator API: added endpoint to bulk create IoT modules

2025-01-22

• User API: updated documentation of customer endpoint responses

2025-01-13

• Operator API: Allow invoices filtering based on an invoice type: REGULAR vs. BUSINESS
• MaaS API:
  • Include business account invoices
  • Allow invoices filtering based on an invoice type: REGULAR vs. BUSINESS

2024-12-30

• User API: Added PENDING_REVERIFICATION driver’s license state to Guser response
• Operator API: Added PENDING_REVERIFICATION driver’s license state to Guser response
• MaaS API: Added PENDING_REVERIFICATION driver’s license state to Guser response

2024-12-26

• User API: Add time zone ID to branch data in booking

2024-12-20

• User API: Add time zone ID to branch data
• Operator API: Add time zone ID to branch data

2024-12-18

• Operator API: allow filtering for Bluetooth events in vehicle activities

2024-12-13

• User API: Add additional data to endpoint for searching available booking time slots

2024-12-09

• Operator API:
  • Consider vehicle in booking create/update validations
  • Include planned vehicle when listing bookings

2024-12-04

• User API: Add endpoint for calculating Booking price
• Fix minor issues with Stoplight representation of user and operations API

2024-11-29

• Operator API: On-demand pricing assignment CRUD API (option to create rate selector by assigning multiple pricing options to vehicle category on a branch)
• User API: Provide multiple on-demand pricing options for a vehicle category on a branch, and enable user to choose one of them when creating a rental.

2024-11-27

• Replace goUrban with Wunder branding

2024-11-19

• User API: Add endpoint for searching available booking time slots
• User API: Add endpoint for fetching single vehicle category

2024-10-15

• User API: Invoice data added to rental

2024-10-14

• Operator API: Allow updating of area and resetting of setting value type when updating a setting

2024-10-10

• Operator API: Expose vehicle docking/undocking on station events and details in vehicle activities

2024-10-07

• FT-25: Include userGroup on rental single endpoint

2024-10-04

• DEV-4336: Booking billing overview

2024-10-01

• DEV-4391: Add includeOnDemandOnly parameter to rentals filter

2024-09-24

• DEV-4277: Refund line item on open invoice

2024-09-23

• Formatting and minor changes in description of cancellationInformation

2024-09-17

• DEV-4276: Endpoint to list invoice line items

2024-09-13

• DEV-4297: Expose start/end branch and user group in booking endpoints of operator API

2024-09-12

• DEV-4300: Add to event dto

2024-09-09

• DEV-4262: Fetch vehicle details by qr code

2024-09-05

• Add isExtendable information to bookingListDTO

2024-09-03

• Add scheduler to trigger docking updates on failed end rentals

2024-08-30

• DEV-4210: Remove branchChangedDetails

2024-08-27

• DEV-4165: Add to openapi

2024-08-26

• DEV-4134: Fetching verification files

2024-08-09

• Add branchId to fetch balance endpoint

2024-07-31

• User API and Operator API for Physical Stations

2024-07-29

• Added ID field to balanceUpdates endpoint
• Allow operators to accept Terms and Conditions on a customer’s behalf

2024-07-26

• Added raw field for rawInvoiceDescription

2024-07-25

• Search branches inside hierarchy

2024-07-22

• Expose voucherable translation keys
• DEV-3892: Assignees full text search
• Tags and syntax errors fixes in OpenAPI spec

2024-07-20

• Support updating of the cost center of a booking

2024-07-19

• Add blockstate to MaaS GET/PATCH endpoints

2024-07-18

• Updated documentation for UserGroup Issues

2024-07-16

• DEV-3891: Add rentalId to activity response

2024-07-11

• Allow setting of type of booking when validating booking time.

2024-07-09

• DEV-3738: Add branch activity data to vehicle activities endpoint in operator API

2024-07-08

• Include vehicle categories from already created bookings

2024-07-05

• DEV-3789: Improve task fetching
• Tags and summary for booking conflicts/check-booking-creation-availability endpoints

2024-07-04

• DEV-3788: Improve damage fetching loading time
• Exclude booking from booking availability validate endpoint.

2024-07-03

• Booking created_by and updated_by.

2024-06-27

• Remove obsolete cashback

2024-06-26

• DEV-3651: Add cost center archive functionality

2024-06-21

• Missing documentation for Rating endpoints

2024-06-18

• Extend user creation through operations-api with emailIsVerified and passwordResetFlow

2024-06-13

• Terms and Conditions: possibility to reference previous version when creating new one.

2024-06-07

• Expose more vehicle events.
• DEV-3565: Expose vehicle telemetry in operator API.

2024-06-06

• Allow filtering of vehicle activities by a date parameter.
• Endpoint to validate time constraints and availability of a potential booking.

2024-06-04

• Allow changing the vehicle category of a booking in Operator API.

2024-06-03

• Assign X-th ride reward voucher on successful rental end
• Allow ignoring of time constraints on bookings for Admins

2024-05-23

• Expose additions in booking list API call
• Add price and rental distance to list booking endpoint in operator API

2024-05-21

• Add details for geofence surcharge creation

2024-05-17

• Vehicle categories search

2024-05-16

• Include category name in vehicles list response
• Include distance in rental list response

2024-05-10

• Annotation filter by type

2024-05-03

• Make branch optional for all RFID cards.

2024-04-17

• User correct user when checking terms and conditions

2024-04-16

• Check capacity issues during booking creation

2024-04-10

• Added Pricing calculator for pricing bundles

2024-04-05

• Add endpoints to properly support prolong booking

2024-04-02

• Booking conflicts

2024-03-21

• Additional fields for damages
• Overwrite pricing bundle for booking
• Booking Cancellation by operator with possibility to waive or apply booking cancellation fees

2024-03-20

• operations-api - Added missing endpoints and fixed tags and description

2024-03-18

• List vehicle cards and details for active rentals in User API
• Added possibility to specify a pricing bundle when retrieving additions to get a price estimation for a specific pricing bundle.
• Check rental start requirements

2024-03-15

• Include pricing bundles in booking station vehicle category
• Allow excluding blocked users from user search result
• Allow specifying of a vehicle already when creating a booking via Operator API

2024-03-14

• Enable filtering for users which are assigned to user-groups
• Enabled adding notes to bookings in operator API

2024-03-13

• List vehicle categories for a booking station

2024-03-12

• Expose user groups of users when searching for users in operator API
• Use UserGroupId instead of code to create bookings on operator API.
• List bookings which are active within timeframe

2024-03-11

• Manage Business Account Members for operations-api
• Booking stations overview

2024-03-07

• Update openAPI operatorId in Operator API

2024-02-28

• Allow setting of user’s desired language during user creation

2024-02-26

• Add superior email to business account member
• Expose setting of business account

2024-02-23

• Expose CreditStatus of user on list endpoint

2024-02-22

• Added Driving Log

2024-02-16

• Expose and allow setting of the language of the user

2024-02-12

• Added endpoint to set invoice to paid externally for MaaS use-case

2024-02-06

• Expose pricing details of bookings.

2024-02-02

• Provide cancellation information and potential costs of bookings

2024-01-17

• Support for multiple newsletter/marketing options

2024-01-04

• Deprecated POST customers/impersonate in favor of POST customers (createMaaSUser) of MaaS API

2023-12-28

• Added editable until to the booking response

2023-12-21

• Add support for attribute filtering in /available-categories and /availability.

2023-12-14

• Updated operations/user/maas-api

2023-11-24

• Initial documentation for user, operations and maas API.