Skip to main content
GET
Check the state of a linking URL you created with Create a Link Session — whether your user has opened it, whether it is still valid, and how many times it has been used. Useful when you want to know if a user has started connecting their accounts without asking them, or to confirm a link is dead before creating a replacement.
A sessionId that does not exist, or that belongs to another account, returns the same not found response. This is deliberate, so the endpoint cannot be used to discover whether an identifier is real.

Header Parameters

Path Parameters

string
required
The sessionId returned when the link was created.
The state field is one of:
  • pending: created, never opened.
  • active: opened at least once, still within its window.
  • expired: past expiresAt.
  • revoked: killed with Revoke a Link Session.
A revoked link reports revoked even after its window passes, since that is the more useful answer.

Connected Accounts

When your user connects an account, the link records it. Three fields appear once something has been connected, and are absent until then:
  • completedAt: when the first account was connected.
  • lastCompletedAt: when the most recent one was.
  • completedNetworks: every network connected on this link.
These are separate from state, and both answer real questions: a link can be active and have connected nothing yet, or expired and have connected three accounts before it ran out. Polling for completedNetworks is how a server-rendered app or a mobile app knows a connection finished, and it is the only signal for Telegram, which completes out of band.
completedNetworks is a history of this link session, not the profile’s current state. It is append-only: a network is added when it connects through this session and is never removed, so it stays listed after the account is unlinked, relinked through a different session, or disconnected on the network’s side. To see which networks are linked to the User Profile right now, call Get User Profiles with include=state.