Retrieving Customer Contacts
People: contacts at B2B customer accounts (contact_type b2b) and standalone retail customers (b2c).
Use GET /api/v1/customer-contacts to page through every record in your organization, or GET /api/v1/customer-contacts/{id} to fetch a single record. The id is a string, and a 404 means it doesn't exist in your organization.
API Endpoint
Current Use Cases
Pull everyone at your B2B accounts plus retail customers into one list for your CRM or email tool.
Filter by email to match an incoming order or message to the right person and account.
Filter by contact_type to send wholesale updates to buyers and promos to retail customers.
Compare contacts across systems to merge people who were entered twice.
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)