X Accounts

Get X account connect link status

Changed on

Reads what happened on a link. status reads connected once the person finishes, with xUserId, xUsername & health. It never holds the token. Takes a Full access API key holding connectsXAccounts, or a dashboard session.

get/api/v1/x/account-connection-links/{id}

Request

  • Base URL
    https://xquik.com
  • Auth
    • API key in header x-api-key
    • or API key in cookie __Host-xquik_session

Path parameters

idstring required
Example:xlink_AAAAAAAAAAAAAAAA

Connect link ID returned when you created the link.

Response

The link's current state.

object'x_account_connection_link' required
idstring required
purpose'connect' | 'reconnect' required
status'pending' | 'connecting' | 'requires_email_code' | 'connected' | 'failed' | 'expired' | 'revoked' required

failed means 5 logins were refused, so make a new link. revoked means you revoked it, or the key that made it is paused, revoked, expired, no longer Full access or without connectsXAccounts. A link whose key resumes within its 30 minutes reads pending again.

referencestring nullable required
returnUrlstring uri nullable required
apiKeyIdstring nullable required

The ID of the API key that made the link, or null when a dashboard session made it.

accountIdstring nullable required
xUserIdstring nullable required
xUsernamestring nullable required
healthstring nullable required
failurestring nullable required

Why the last login didn't finish.

createdAtstring date-time required
expiresAtstring date-time required
completedAtstring date-time nullable required
urlstring uri

Present only in the response that creates the link.

Example response

{
  "object": "x_account_connection_link",
  "id": "xlink_AAAAAAAAAAAAAAAA",
  "purpose": "connect",
  "status": "connected",
  "reference": "crm-user-7",
  "returnUrl": "https://app.example.com/connected",
  "apiKeyId": "17",
  "accountId": "42",
  "xUserId": "9876543210",
  "xUsername": "elonmusk",
  "health": "healthy",
  "failure": "login_failed",
  "createdAt": "2026-11-08T12:00:00Z",
  "expiresAt": "2026-11-08T12:30:00Z",
  "completedAt": "2026-11-08T12:02:00Z",
  "url": "https://xquik.com/connect-x#token=CONNECT_LINK_TOKEN"
}

Changes