List available reports
GET/api/reports
Discovery endpoint for a dashboard or BI tool. Returns every reporting endpoint this plugin exposes, the query parameters each one accepts and the shared date range rules, so a client can build its panels without hardcoding the catalogue.
meta.max_groups is the largest page a grouped list will return. The reports that expose limit and offset page their list with it, and every report that caps a list reports the cap through its own meta.truncated map, so nothing is ever dropped in silence.
Headers
| Field | Type | Description |
|---|---|---|
| authtoken | String | Authentication token, generated from admin area |
curl -X GET "https://yoursite.com/api/reports" \
-H "authtoken: YOUR_API_TOKEN"Success-Response:
HTTP/1.1 200 OK
{
"status": true,
"data": [
{
"key": "summary",
"path": "/api/reports/summary",
"description": "Headline counts across clients, leads, projects, tasks, tickets and invoices, as of now.",
"parameters": []
}
],
"meta": {
"date_format": "YYYY-MM-DD",
"default_range_days": 30,
"max_range_days": 366,
"server_date": "2026-07-22"
}
}