Show Dashboard
GET/api/xero/dashboard
Get the Xero integration dashboard data including integration status, connection health, entity counts, and webhook summary.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Returns null data if no integration instance is configured.
Authorization health: integration_status.authorized_at is when the stored Xero grant was authorized, and integration_status.missing_scopes lists the accounting.* permissions SKU.io requests today that the grant was authorized without (a grant is frozen at authorization time; permissions added to the app later are absent until the tenant re-authorizes). A non-empty list means every call that needs one of those permissions fails with insufficient_scope while the rest of the connection keeps working — re-authorize Xero once to clear it. Empty when the grant is current; both are null / empty when no access token is stored.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.