Skip to main content
GET
/
v1
/
links
/
{link_id}
Retrieve a Link
curl --request GET \
  --url https://api.example.com/v1/links/{link_id}

​
Description

This endpoint retrieves a Link.

​
Authentication

This endpoint requires API credentials via header authentication:
  • Client ID (header)
  • Access Key (header)

​
Path Parameters

ParameterTypeRequiredDescription
link_idstringYesThe unique identifier of the link to retrieve

​
Response

​
Success Response (200 OK)

Returns a Link object with all properties. 
{
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "created_at": "2022-06-07T15:00:00Z",
  "updated_at": "2022-06-31T15:00:00Z",
  "tracking_info": "user123456",
  "status": "new",
  "user_external_id": "user123456",
  "provider_id": "adp",
  "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa"
}

​
Error Responses

401 Unauthorized: Invalid or missing authentication credentials. 403 Forbidden: Insufficient permissions for the authenticated user. 404 Not Found: The specified link ID does not exist.