X accounts
X account connection API for profile status
Check a connected X account before tweets, replies, DMs, likes, follows, or profile updates. Read healthy, recovering, temporaryIssue, or needsReauth.
- 200
- 400
- 401
- 404
- 429
GET
X account connection API for profile status
When to check one account
Call this route before one connected-account write. Read health, recovery, and credential state before selecting the next action. Use list to see every connected account.Free. This endpoint does not consume credits.
health first. Write with healthy. Use recovering on the next action. Wait or bulk retry temporaryIssue. Re-authenticate needsReauth. Fix locked or suspended on X before retrying writes.
Read the account state
Ready for actions
health: "healthy" means the stored session is usable. connectedAt shows when the account last connected or reconnected. The API omits it if the account has not authenticated yet.Needs credentials
health: "needsReauth" means credentials, TOTP, email verification, passkey, or another security challenge blocked login. Use Re-authenticate with current credentials and a valid TOTP secret before retrying writes.Temporary recovery
health: "temporaryIssue" means a transient or automated cooldown is still active. Wait for recovery, or use Bulk retry for temporary failures. health: "recovering" means the account can reconnect on its next use.X restriction
health: "locked" or health: "suspended" means writes stay blocked until you fix the account on X. Re-authenticate or reconnect only after the account is usable again.Path parameters
string
required
The unique account ID. Returned when you connect an account or list accounts.
Headers
string
required
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
Response
200 OK
string
Unique account ID.
string
X username.
string
X user ID.
string
Account connection status (for example
"active").string
Derived login and cookie health. One of
healthy, locked, needsReauth, recovering,
suspended, temporaryIssue. See Account health
for meanings.string
ISO 8601 timestamp of when the account last connected or reconnected. Omitted if not yet
authenticated.
string
ISO 8601 timestamp of when you connected the account.
string
ISO 8601 timestamp of the last update.
400 Invalid ID
401 Unauthenticated
404 Not found
429 Rate limited
Retry-After value before fetching this account again.
Related. List X Accounts to see all accounts, Disconnect to remove this account, or Re-authenticate if the session has expired.