Skip to Content

Get Link

Retrieve the current status and result of a link.

Request

GET /v1/links/:id

Headers

HeaderValue
AuthorizationBearer YOUR_API_KEY

Path parameters

ParameterDescription
idThe link ID

Response

200 OK

{ "id": "link_abc123", "provider": "tmobile", "externalUserId": "user_456", "status": "complete", "currentSessionId": "session_xyz789", "result": { ... }, "error": null, "expiresAt": 1704081600000, "createdAt": 1704067200000, "updatedAt": 1704070800000 }

Status values

StatusDescription
pendingLink created, not yet claimed
activeAutomation in progress
completeSuccessfully finished
failedAutomation failed (re-claimable)
expiredLink expired before completion
Last updated on