Get a Link Session

Check whether a social-linking URL has been opened, is still valid, or has been revoked.

GET /profiles/link-sessions/{sessionId}

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Profile-Key: PROFILE_KEY' \
-X GET https://api.ayrshare.com/api/profiles/link-sessions/SESSION_ID

200: Opened Once, Still Valid

{
    "status": "success",
    "sessionId": "c7a2434e72e91bde27579efde0fd6dd0b74ceee29a471fd368407f273708c2e8",
    "state": "active",  // pending | active | expired | revoked - see Link States above.
    "createdAt": "2026-09-01T08:03:26.838Z",  // When the link was created, as an ISO 8601 timestamp.
    "expiresAt": "2026-09-02T08:03:26.838Z",  // When the link stops working.
    "firstUsedAt": "2026-09-01T08:14:02.104Z",  // When the link was first opened. Absent if it never has been.
    "lastUsedAt": "2026-09-01T08:14:02.104Z",  // When the link was most recently opened. Absent if it never has been.
    "useCount": 1  // How many times the link has been opened. A reload or an OAuth retry increments this.
}

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

sessionId · string · required

The sessionId returned when the link was created.

Link States

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.

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Profile-Key: PROFILE_KEY' \
-X GET https://api.ayrshare.com/api/profiles/link-sessions/SESSION_ID

200: Opened Once, Still Valid

{
    "status": "success",
    "sessionId": "c7a2434e72e91bde27579efde0fd6dd0b74ceee29a471fd368407f273708c2e8",
    "state": "active",  // pending | active | expired | revoked - see Link States above.
    "createdAt": "2026-09-01T08:03:26.838Z",  // When the link was created, as an ISO 8601 timestamp.
    "expiresAt": "2026-09-02T08:03:26.838Z",  // When the link stops working.
    "firstUsedAt": "2026-09-01T08:14:02.104Z",  // When the link was first opened. Absent if it never has been.
    "lastUsedAt": "2026-09-01T08:14:02.104Z",  // When the link was most recently opened. Absent if it never has been.
    "useCount": 1  // How many times the link has been opened. A reload or an OAuth retry increments this.
}