GET/v1/dashboard

The organisation dashboard

Next planned run per product group with the scheduled count, items needing attention, pending approvals, the billing figures, thirty-day counts, QR scan totals, the last twenty events and the onboarding checklist.

Scope items.read

Returns

11 fields of the 200 answer

runsarray of objectsrequired

4 fields

productGroupstringrequired

runobject or nullrequired

4 fields

idstringrequired

cutoffAtdate-timerequired

handoverWeekstringrequired

handoverMondaydaterequired

expectedDeliveryFromdate or nullrequired

scheduledintegerrequired

needsAttentionintegerrequired

pendingApprovalsintegerrequired

scheduledintegerrequired

sentLast30Daysintegerrequired

createdLast30Daysintegerrequired

scansintegerrequired

billingobjectrequired

7 fields

billingModeenumrequired

PREPAIDTRIALINVOICE

availableCentsintegerrequired

balanceCentsintegerrequired

outstandingCentsintegerrequired

creditLimitCentsintegerrequired

creditUsagePercentinteger or nullrequired

trialobject or nullrequired

3 fields

itemsRemainingintegerrequired

expiresAtdate-time or nullrequired

activebooleanrequired

checklistarray of objectsrequired

3 fields

keyenumrequired

profiletemplatePublishedsampleOrderedapiKeyOrIntegrationpostflowActiverunParticipated

donebooleanrequired

linkstringrequired

onboardingCompletebooleanrequired

recentActivityarray of objectsrequired

4 fields

idstringrequired

typestringrequired

createdAtdate-timerequired

payloadobjectrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

{ "runs": [ { "productGroup": "Example", "run": { "id": "run_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "cutoffAt": "2026-10-16T09:14:02.000Z", "handoverWeek": "Example", "handoverMonday": "2026-11-02" }, "expectedDeliveryFrom": "2026-11-02", "scheduled": 1 } ], "needsAttention": 1, "pendingApprovals": 1, "scheduled": 1, "sentLast30Days": 1, "createdLast30Days": 1, "scans": 1, "billing": { "billingMode": "PREPAID", "availableCents": 1250, "balanceCents": 1250, "outstandingCents": 1250, "creditLimitCents": 1250, "creditUsagePercent": 1, "trial": { "itemsRemaining": 1, "expiresAt": "2026-10-16T09:14:02.000Z", "active": true } }, "checklist": [ { "key": "profile", "done": false, "link": "Example" } ], "onboardingComplete": false, "recentActivity": [ { "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "type": "item.completed", "createdAt": "2026-10-16T09:14:02.000Z", "payload": {} } ] }