Get a detailed health report for an account
GET/accounts/:id/health
Tells clients whether an account is currently usable (token alive, no
reconnection required, recent publish activity). status verdicts:
healthy (post away), warning (recent_permanent_failures or
token_expiring_soon — posting still allowed), broken
(account_inactive, needs_reconnection or token_expired —
can_post is false).
Request
Responses
- 200
- 400
- 401
- 402
- 403
- 404
- 429
- 500
Health report
Validation error — see error.code and error.details
Missing/invalid/revoked/expired API key (codes invalid_api_key, api_key_revoked, api_key_expired, api_key_required, auth_failed). Auth-layer 401s omit error.retryable and meta.request_id.
No active subscription (code subscription_required — the error object also carries subscription_status), or insufficient AI credits (insufficient_credits) / paid plan required (upgrade_required).
API key missing the required scope (insufficient_scope), storage quota exceeded (storage_quota_exceeded), or account limit reached (account_limit_reached)
Resource not found in your organization/workspace (not_found)
Rate limit exceeded (rate_limit_exceeded, or plan budgets post_limit_reached / daily_limit_reached on schedulePost). All 429s carry Retry-After. The API-key limiter additionally sets the X-RateLimit-* headers and error.details {limit, remaining, reset_at}.
Response Headers
Seconds to wait before retrying
Requests allowed in the window (API-key limiter only)
Requests remaining (API-key limiter only)
Unix seconds when the window resets (API-key limiter only)
Internal error (internal_error and endpoint-specific 5xx codes). Retryable.