The Operations API is for building operator-side tooling on top of the Wunder Mobility platform. Typical consumers are shared mobility operators who want to build their own support tools, fleet management workflows, reporting utilities, finance back-office workflows, or internal automations.
Use the Operations API when the actor is an operator, administrator, service agent, or internal system working with branch-scoped operational data. If an operator is building a white-label end-user mobile or web app, use the User API. If the actor is a MaaS partner, use the MaaS API.
| Related reference: Operations API | Authentication | Pagination | Error Codes |
| Audience | Typical use cases |
|---|---|
| Mobility operators | Custom support tools, fleet operations, branch administration, invoice review, user management. |
| Service operations teams | Vehicle relocation, maintenance workflows, tasks, damages, operational state changes. |
| Finance and reporting teams | Invoice review, rental exports, operational reconciliation, business reporting. |
| Internal automation teams | Controlled automations around operator workflows, branch-scoped monitoring, support processes. |
The Wunder APIs are designed for different actors and traffic patterns.
| API | Primary actor | Typical traffic pattern | Use it for |
|---|---|---|---|
| Operations API | Operator, admin, service agent | Lower-frequency operator workflows with richer branch-scoped queries and administrative actions | Fleet management, support, finance, branch administration, operational tooling. |
| User API | Operator-owned white-label end-user app | High-volume app traffic from many users refreshing availability or managing their own account/rentals | Customer-facing mobile or web applications built by an operator. |
| MaaS API | MaaS partner/API client | Partner integrations that manage users and mobility flows through a MaaS integration model | MaaS partner integrations. |
The User API is optimized for high-volume end-user application usage, where many users may open the app, refresh vehicle availability, or manage their own rentals at the same time. The Operations API is optimized for authenticated operator workflows that usually involve fewer users but richer queries, exports, and high-impact administrative actions.
Design Operations API integrations around operator workflows rather than end-user app interaction loops.
Operations API access is permission-driven. A valid access token only identifies the user or API client; the requested endpoint can still fail if that actor does not have the required permission on the relevant branch or resource.
Most operational workflows are branch-scoped. A user may be allowed to perform an action in one branch and not in another. Commercial and finance workflows can instead be scoped to the business unit, technically the billable branch, behind the operational branch. Some endpoints check one specific permission, while others accept one of several permissions, such as read/update variants or create permissions for related workflows.
Common examples:
| Workflow | Typical permission shape |
|---|---|
| Read operational data | Read permission for the domain and branch. |
| Create or update operational resources | Create/update permission for the domain and branch. |
| Read or manage commercial resources | Permission on the business unit/billable branch, even when the request also references an operational branch. |
| Execute high-impact actions | Action-specific permission, sometimes combined with branch scope. |
| Manage roles or settings | Administrative permissions, often restricted to privileged operator users. |
| Root-only operations | Reserved for Wunder Mobility internal administration and not available to external operator tooling. |
Root permissions are reserved for Wunder Mobility and can only be accessed from Wunder Mobility internal systems. External operator tools should not depend on root permissions being available.
If the API returns an insufficient-permission error, do not retry the same request automatically. Show the operator which action failed and ask an administrator to review the user’s role assignments for the affected branch and, when the workflow is commercial or financial, the linked business unit.
Examples of business-unit-scoped areas include vouchers, promotions, packages, subscriptions, ride passes, customer-care templates, balances, invoices, payments, refunds, settlement, currency, tax, and merchant account configuration. For the detailed model, see the Business Units And Billable Branches Guide.
Use the role endpoints when building administrative tools for permission management:
| Task | Endpoint |
|---|---|
| List available permission types | GET /roles/permissions |
| List roles with permissions | GET /roles |
| Create a role | POST /roles |
| Update a role | PUT /roles/{id} |
| Delete a role | DELETE /roles/{id} |
| Add role actions | POST /roles/{id}/actions |
| Remove role actions | DELETE /roles/{id}/actions |
| List role assignments | GET /roles/assignments |
| List users and roles for a branch | GET /roles/assignments-detailed |
| Add a role assignment | POST /roles/assignments |
| Delete a role assignment | DELETE /roles/assignments/{id} |
| Check whether the current user has a role or permission | GET /roles/assignments/exists |
For custom operator tools, the most useful pattern is to check the current user’s relevant permission before showing high-impact actions, and still handle permission failures from the action endpoint itself. Permission checks are helpful for user experience, but the action endpoint remains the source of truth.
Settings control platform behavior and can enable, disable, or configure functionality across the backend. They can affect availability, booking and rental behavior, payment behavior, dashboard behavior, shared app behavior, scheduler behavior, and other tenant-specific workflows.
Settings are scoped by key, area, and branch. Some settings are global defaults; others are branch-specific overrides. A setting response includes the key, area, branch IDs, value, and, in management responses, metadata such as name, value type, and public visibility.
The setting area describes which part of the platform consumes the setting:
| Area | Meaning | Typical consumer |
|---|---|---|
APP |
Customer-facing app and user web app configuration. | White-label mobile apps and user-facing web flows. |
DASHBOARD |
Operator dashboard configuration. | Operator/admin interfaces and Operations API tooling. |
CORE |
Backend platform configuration. | Core backend services, schedulers, pricing, payment, rate limiting, integrations, and internal workflows. |
SHARED |
Configuration shared across multiple consumers. | Settings used by both app/dashboard or backend/frontend flows. |
For Operations API tooling, start with DASHBOARD and SHARED settings. APP settings are mainly relevant when documenting or building user-facing app flows. CORE settings can change backend behavior and should be treated as administrative platform configuration.
GET /settings is the lightweight read endpoint for selected setting keys. It returns effective DASHBOARD and SHARED settings for the requested keys and optional branch IDs, including fallback/default values where applicable. Use it when a tool already knows which setting keys it needs.
GET /settings-management is the administrative catalog endpoint. Use it to discover which settings exist, inspect setting metadata, filter by key or name, and build settings-management screens. It can return settings across areas such as APP, DASHBOARD, CORE, and SHARED, depending on the caller’s permissions and filters.
Use settings carefully in custom tools:
/settings-management to discover available setting keys and areas before relying on them in a workflow.Use the read endpoint when a tool only needs effective dashboard/shared configuration:
| Task | Endpoint |
|---|---|
Read DASHBOARD and SHARED settings by keys and optional branches |
GET /settings?keys={key1},{key2}&branchIds={branchId} |
Use settings-management endpoints for administrative configuration:
| Task | Endpoint |
|---|---|
| List settings | GET /settings-management |
| Filter settings by key or name | GET /settings-management?key={key}&name={name} |
| Retrieve one setting | GET /settings-management/{id} |
| Create a setting | POST /settings-management |
| Update a setting | PUT /settings-management/{id} |
| Bulk update settings | PUT /settings-management/bulk |
| Delete a setting | DELETE /settings-management/{id} |
| Validate setting database content | POST /settings-management/validate |
| Reload settings cache | POST /settings-management/reload |
The settings catalog is extensive and can evolve. To discover available settings for a tenant, list settings through GET /settings-management and filter by key, name, or exactMatch=true. Domain guides should call out settings that are essential to that workflow, but the full catalog should be discovered from the API rather than copied into each guide.
Use the Operations API Analytics And KPIs Guide for current operational health indicators such as fleet availability, low battery vehicles, offline vehicles, misplaced vehicles, active rentals/bookings, station capacity, open damage, and open tasks.
Do not use the Operations API as a recurring bulk replication mechanism for copying all operational data into another database.
For scheduled or analytical data processing, use the data products designed for that purpose:
| Use case | Recommended option |
|---|---|
| Daily or scheduled files for processing in your systems | Data Exports |
| Webhook notification when an export is ready | Data Exports |
| Direct analytical access to business data | Wunder Mobility data warehouse option |
| Real-time operational events | Platform Webhooks |
| Stored platform and app events | Operations API Events And User Analytics Guide |
| Interactive operator search and actions | Operations API |
| Current operational health dashboards | GET /kpis |
The Operations API can still support targeted operator reporting workflows, such as searching rentals in a branch or reviewing one invoice. For large recurring data ingestion, use exports or the data warehouse.
The Operations API reference contains many endpoint groups. Start with the domain guide that matches the workflow you are building.
| Domain | Guide | Use it for |
|---|---|---|
| Rentals | Operations API Rental Guide | Rental search, inspection, administrative rental actions, deposits, requirements, rental authority. |
| Vehicles | Operations API Vehicle Guide | Fleet inventory, service state, vehicle commands, vehicle categories. |
| Vehicle categories | Operations API Vehicle Category Guide | Category configuration, available actions/commands, rental behavior, battery thresholds, category-level settings. |
| Bookings | Operations API Booking Guide | Scheduled reservations, availability, booking approval, pickup, cancellation, station planning. |
| Customers and groups | Operations API Customers And Groups Guide | User support, business accounts, memberships, cost centers, identity cards, ratings. |
| Pricing and bundles | Operations API Pricing Guide | Pricing bundles, pricing assignments, pricing simulation, packages, and category pricing references. |
| Promotions, packages, subscriptions, and benefits | Operations API Promotions, Packages, Subscriptions, And Benefits Guide | Promotion codes, paid packages, subscription plans, ride passes, customer-care credit, rewards, benefits, and issued vouchers. |
| Payments and invoices | Operations API Payments And Invoices Guide | Invoice review, payment retries, billing workflows, refunds, balances, vouchers. |
| Tasks, damages, and issues | Operations API Tasks, Damages, And Issues Guide | Operational work queues, damage handling, support cases, issue invoicing. |
| Branches and stations | Operations API Branches And Stations Guide | Branch hierarchy, station operations, compatible branches, service areas. |
| Areas | Operations API Areas Guide | Geofenced areas, area types, parking restrictions, end-rental rules, speed limits, notices, and capacity policies. |
| Points of interest | Operations API Points Of Interest Guide | Informational map markers, POI categories, rental visibility, images, and localization. |
| Business units and billable branches | Operations API Business Units And Billable Branches Guide | Business units, billable branch scope, currency, tax, payment routing, balances, invoices, and benefit catalog ownership. |
| Events and user analytics | Operations API Events And User Analytics Guide | Event timelines, app-posted user events, event positions, branch heatmaps. |
| Analytics and KPIs | Operations API Analytics And KPIs Guide | Current fleet, rental, station, task, and damage health indicators. |
Before implementing an Operations API integration: