Retrieving Customers
Customer (B2B) accounts with contacts and ship/bill locations.
Use GET /api/v1/customers to page through every record in your organization, or GET /api/v1/customers/{id} to fetch a single record with its related data. The id is a UUID, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
Send B2B accounts with their contacts and ship/bill locations to your CRM so sales and ops see the same customer.
Pull ship-to locations so labels and shipments go out with the right address.
Filter by account_code to match a Cloudbox customer to the same account in your ERP.
Use updated_since to catch address or contact changes and update invoices.
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)