public-api-docs

User API Groups And Business Accounts Guide

Overview

Groups are user-facing business accounts. They support membership, join/leave requests, managed groups, member properties, cost centers, business rentals, business bookings, and billing summary views. Use these endpoints when building configured business-account self-service in a white-label app.

Related reference: User API User API Guide Rental Guide Booking Guide Commercial Products Guide

Core Concepts

Member View vs Management View

The /groups endpoints are for the current user’s membership experience. The /groups-management endpoints are for configured users who can manage groups.

Business Context

Business rentals and bookings can require group membership, member properties, cost centers, reasons, billing settings, and branch/category compatibility. Validate this context before creating rentals or bookings.

On the rental start screen, treat an eligible group as a billing option next to the user’s personal payment methods. Load memberships with GET /groups, let the user select the business account, then create the rental with userGroupCode and type: "BUSINESS" where the app sends an explicit rental type. Do not pass a personal payment source ID for the business rental; the group selection determines the billing context.

Run GET /rentals/requirements again after the user selects a group. Requirements can differ between personal and business rentals because group membership, approval, payment configuration, unpaid invoices, branch/category permissions, reasons, or cost-center-related setup can apply only to the selected business context.

Cost Centers

Cost centers let configured group administrators organize billing and reporting. They are managed separately from group membership but used together in business booking and rental flows.

Common User Workflows

Member Flows

Task Endpoint
List groups current user belongs to GET /groups
List current user’s group requests GET /groups/requests
Update a group request PATCH /groups/requests/{requestId}
Join a group POST /groups/{groupCode}/join
Leave a group POST /groups/{code}/leave

Use these endpoints for “my business accounts”, invitation, join request, and leave flows.

Group Owner And Manager Flows

Task Endpoint
List owned groups GET /groups-management
Create group POST /groups-management
Get group detail GET /groups-management/{userGroupId}
Update group PATCH /groups-management/{userGroupId}
Delete group DELETE /groups-management/{userGroupId}
Add members POST /groups-management/{userGroupId}/add-members
Update member by member code PATCH /groups-management/{userGroupId}/{memberCode}

Group management changes can affect who is allowed to create business rentals and bookings.

Members And Requests

Task Endpoint
List group members GET /groups-management/{userGroupId}/members
View member properties GET /groups-management/{userGroupId}/members/{userId}
Patch member properties PATCH /groups-management/{userGroupId}/members/{userId}
Replace member properties PUT /groups-management/{userGroupId}/members/{userId}
List group requests GET /groups-management/{userGroupId}/requests
Update group request PATCH /groups-management/{userGroupId}/requests/{requestId}

Use member-property endpoints when a group needs per-member settings such as approval, billing role, cost-center access, or tenant-specific metadata.

Cost Centers

Task Endpoint
List cost centers GET /cost-centers
Create cost center POST /cost-centers
Get cost center GET /cost-centers/{costCenterId}
Update cost center PATCH /cost-centers/{costCenterId}
Delete cost center DELETE /cost-centers/{costCenterId}

Cost-center availability can influence the fields required when creating a business booking or rental.

Business Activity And Billing

Task Endpoint
List group bookings GET /bookings/user-group/{userGroupId}
List group rentals GET /rentals/user-group/{userGroupId}
Show group billing summary GET /groups-management/{userGroupId}/billing-summary

Use these endpoints for owner-facing activity views. For operator-side customer and business account administration, use the Operations API instead.

Most Relevant APIs

Area Endpoints
Member groups GET /groups, GET /groups/requests, PATCH /groups/requests/{requestId}, POST /groups/{groupCode}/join, POST /groups/{code}/leave
Group management GET /groups-management, POST /groups-management, GET/PATCH/DELETE /groups-management/{userGroupId}, POST /groups-management/{userGroupId}/add-members, PATCH /groups-management/{userGroupId}/{memberCode}
Members and requests GET /groups-management/{userGroupId}/members, GET/PATCH/PUT /groups-management/{userGroupId}/members/{userId}, GET /groups-management/{userGroupId}/requests, PATCH /groups-management/{userGroupId}/requests/{requestId}
Cost centers GET /cost-centers, POST /cost-centers, GET/PATCH/DELETE /cost-centers/{costCenterId}
Business activity GET /bookings/user-group/{userGroupId}, GET /rentals/user-group/{userGroupId}, GET /groups-management/{userGroupId}/billing-summary

Implementation Notes