Retrieving Customer Groups
Groupings of customer accounts.
Use GET /api/v1/customer-groups to page through every record in your organization, or GET /api/v1/customer-groups/{id} to fetch a single record. The id is a UUID, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
Use customer groups (wholesale, distributor, VIP) to apply the right price list in your storefront or ERP.
Roll up orders by group to see which customer type drives the most revenue.
Send updates to one group at a time, like all distributors, without building lists by hand.
Mirror Cloudbox groups in your CRM so sales and ops segment customers the same way.
Required Headers
Every request must include the following:
Requests missing either header will return 401 Unauthorized
Example Request
Response Schema
Filters
Errors
Cloudbox uses standard HTTP status codes to indicate API success or failure:
- 200–299 – Request succeeded
- 400 – Bad request (missing parameters, invalid values)
- 401 – Unauthorized (missing or invalid API keys)
- 404 – Resource not found
- 429 – Too many requests (rate limited)