Our API enables you to integrate with Common Ground’s GraphQL APIs to build applications that manage inventory, process orders, handle checkouts, and create e-commerce experiences.
API Documentation: https://docs.common-ground.io
What can I do with the Common Ground APIs?
Manage product catalogs and inventory remotely
Process orders and track fulfillment in real-time
Create custom checkout experiences with flexible payment options
Access customer data and purchase history
Generate analytics and reports on sales performance
Integrate with third-party logistics and shipping providers
Build custom storefronts and marketplace applications
Automate inventory synchronization across channels
Which accounts can access the APIs?
API access is exclusively available to Extended accounts. If you're currently on a different plan, you can upgrade to an Extended account through your account settings to unlock API access.
How to generate an API access key
Any team member can generate their own access tokens:
Log in to your Common Ground dashboard
Navigate to profile preferences
Click "Generate an API Key"
Copy your API key and secret
Store your credentials securely (we recommend using environment variables)
Important: Never commit API keys to version control or expose them in client-side code.
How to delete an API access key
Any team member can revoke their own access tokens from the same interface.
Note: Deleting an API key immediately revokes access. Any applications using that key will stop working.
FAQ
What is the rate limit for API requests?
Standard accounts have a limit of 100 requests per minute.
Do you support webhooks?
Not yet, webhooks will become available in a near future. For now a developer may perform regular pulling from the APIs to retrieve new data.
Is there a sandbox environment for testing?
No, they access keys are provided for the live account.
What authentication method does the API use?
We use OAuth 2.0 for authentication with bearer tokens.
Where can I find code examples?
See our API Documentation : https://docs.common-ground.io/
How do I report API issues or request features?
Create a support ticket from the backoffice's support section, an agent will get back to you as soon as possible.