The CleanCloud API lets you read and update your customers and orders from your own systems or third-party tools. Use it to connect a custom app or web ordering tool, build custom reports, or set up hardware integrations. Go to More > Store Settings > Developer > API to find your key.
The API is available on the Grow and Grow+ plans. Customers in Mexico can also use the API on the Pro plan.
Note: If you use CleanCloud’s own pickup and delivery apps, you do not need the API. Orders sync automatically.
How to get your API key
Go to More > Store Settings > Developer > API.
Under API Key, select Reveal.
Copy the key into your integration. Every request needs it.
For endpoints, examples, and rate limits, select View API Documentation, or go to cleancloudapp.com/api.
Important: Treat your API key like a password. Anyone with it has full access to your account through the API. Only reveal it when you need to copy it, and never share it by email or chat.
How to regenerate your key
If your key may have been shared or leaked, select Regenerate. Your old key stops working, so update every integration that uses it.
Monthly usage and limits
Monthly Usage shows how many API requests you have used this month, out of 50,000, and how many remain.
Monthly limit: 50,000 requests.
Rate limit: up to 3 requests per second.
How to increase your limit
You can add bundles of 25,000 extra requests per month for $15.00 each (USD, GBP, or EUR). To add one, contact CleanCloud Support. Requests can take up to 72 hours to process.
Multiple stores
Each store has its own API key. If you have several stores, use the key for the store you are querying.
Common questions
Who can use the API?
Who can use the API?
Customers on the Grow and Grow+ plans. Customers in Mexico can also use the API on the Pro plan.
How do I get customer and order data?
How do I get customer and order data?
Use the api/getCustomer endpoint to get customer data and api/getOrders to get order data. Each order in the getOrders response includes an id (the order ID) and a customerID (the customer ID), so you can link orders to customers. See the API documentation for details.
Can CleanCloud send updates to my system automatically?
Can CleanCloud send updates to my system automatically?
Yes. Use webhooks to get updates about customers and orders as they happen. See Webhook Settings.
Does CleanCloud Support help build integrations?
Does CleanCloud Support help build integrations?
CleanCloud does not offer direct support for developing or troubleshooting custom API or webhook integrations. Use the API documentation or work with a third-party developer.