RelayAPI

Check health of a single connected account

GET
/v1/accounts/{id}/health
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Path Parameters

id*string

Resource ID

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/accounts/string/health"
{  "avatar_url": "string",  "display_name": "string",  "error": {    "code": "string",    "message": "string"  },  "healthy": true,  "id": "string",  "platform": "string",  "scopes": [    "string"  ],  "sync": {    "consecutive_errors": 0,    "enabled": true,    "last_error": "string",    "last_error_at": "string",    "last_sync_at": "string",    "next_sync_at": "string",    "rate_limit_reset_at": "string",    "total_posts_synced": 0,    "total_sync_runs": 0  },  "token_expires_at": "string",  "username": "string"}

Found something wrong? Help us improve this page.