Sign in
Accounts

Check account health

Returns detailed health info for a specific account including token status, permissions, and recommendations.

For WhatsApp accounts the response also includes platformConnection, a live probe of the Meta link behind the channel (the same read as GET /v1/whatsapp/number-info). The OAuth token can be perfectly valid while Meta refuses to serve the phone-number object (for example after a phone-side coexistence disconnect), so tokenStatus alone is not a liveness signal for WhatsApp. When the Meta link is dead, platformConnection.status is disconnected and the overall status is error.

get/v1/accounts/{accountId}/health

Path parameters

accountIdstring required

The account ID to check

Response

Account health details

accountIdstring
platformstring
integrationLane'business' | 'developer'

TikTok only. The TikTok integration the account is connected through: business (TikTok for Business, Accounts API) or developer (the original integration). Absent on other platforms.

usernamestring
displayNamestring
status'healthy' | 'warning' | 'error'

Overall health status

issuesstring[]

List of issues found

recommendationsstring[]

Actionable recommendations to fix issues

Changes