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", "status": "completed", "result": { ... }, "error": null, "created_at": "2025-01-01T00:00:00Z" }

Status values

StatusDescription
createdLink created, not yet claimed
claimingSession being created
activeAutomation in progress
completedSuccessfully finished
failedAutomation failed (re-claimable)
Last updated on