Skip to main content
GET https://xquik.com/api/v1/x/accounts/{id}

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.
Use this endpoint before a workflow acts with one connected account. Read 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

Headers

Response

200 OK

400 Invalid ID

{ "error": "invalid_id", "message": "Invalid account ID format" } The provided account ID is not a valid format.

401 Unauthenticated

{ "error": "unauthenticated", "message": "Missing or invalid API key" } Missing or invalid API key.

404 Not found

No account exists with this ID, or it belongs to a different Xquik account.

429 Rate limited

{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 1 } Wait for the Retry-After value before fetching this account again.
Related.

Response examples

  • 400 { "error": "invalid_input", "message": "Invalid input. Check the request body." }
  • 401 { "error": "unauthenticated", "message": "Authentication required. Provide a valid API key or bearer token." }
  • 403 { "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." }
  • 404 { "error": "not_found", "message": "Resource not found." }
  • 429 { "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 }