Profiles
Get a Link Session
Check whether a social-linking URL has been opened, is still valid, or has been revoked.
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.Link States
Thestate field is one of:
pending: created, never opened.active: opened at least once, still within its window.expired: pastexpiresAt.revoked: killed with Revoke a Link Session.
revoked even after its window passes, since that is the more
useful answer.