This API will help you integrate with Common Ground's powerful GraphQL APIs to build applications that manage inventory, process orders, handle checkouts, and create engaging e-commerce experiences.
What can I do with the Common Ground APIs?
The Common Ground APIs enable you to:
- 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 your access keys?
Any team member can generate their own access tokens:
1. Log in to your Common Ground dashboard
2. Navigate to your profile preferences
3. Click "Generate an API Key"
7. Copy your API key and secret
8. 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 access keys?
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
Q: What is the rate limit for API requests?
A: Standard accounts have a limit of 100 requests per minute.
Q: Do you support webhooks?
A: 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.
Q: Is there a sandbox environment for testing?
A: No, they access keys are provided for the live account.
Q: What authentication method does the API use?
A: We use OAuth 2.0 for authentication with bearer tokens.
Q: Where can I find code examples?
A: Check out our website for more information
https://docs.common-ground.io/
Q: How do I report API issues or request features?
A: Create a support ticket from the backoffice's support section, an agent will get back to you as soon as possible.