REST API
GrowPanel exposes its entire dataset and every dashboard report via a REST API. Pull metrics, push customers and invoices from your own systems, subscribe to events, and build automations.
Base URL: https://api.growpanel.io
→ Open the interactive API reference
Full endpoint catalogue with typed schemas, example requests, and try-it-out powered by your API key.
Official SDKs
Use a typed SDK instead of building raw HTTP calls. All three are auto-generated from the same OpenAPI spec, so they stay in lock-step with the API.
| Language | Install | Repo |
|---|---|---|
| JavaScript / TypeScript | npm install @growpanel/sdk | growpanel-sdk-js |
| Python | pip install growpanel | growpanel-sdk-python |
| Go | go get github.com/growpanel/growpanel-sdk-go | growpanel-sdk-go |
The interactive reference shows ready-to-paste example code in all three languages for every endpoint.
Concepts
- Authentication — issuing and using API keys
- Rate limiting — request limits and back-off advice
- Error codes — what each HTTP status means
Quick example
Fetch your current MRR with cURL:
curl https://api.growpanel.io/reports/summary \
-H "Authorization: Bearer YOUR_API_KEY"{
"summary": {
"mrr_current": 125000,
"arr_current": 1500000,
"subscribers_current": 250,
"arpa_current": 500
},
"currency": "usd"
}Same call with the JavaScript SDK:
import { GrowPanel } from '@growpanel/sdk';
const gp = new GrowPanel({ apiKey: process.env.GROWPANEL_API_KEY });
const summary = await gp.reports.getSummary();
console.log(summary.data.summary.mrr_current);Related
- Building integrations — how to connect custom billing systems
- Custom API data source — step-by-step setup guide
- CLI — terminal client wrapping the same API
- MCP server — connect AI assistants to your data
