Get Tracking Link (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/tracking-links/:linkId

Description

Retrieve a specific tracking link by ID.

Authentication

Required: Workspace authentication. User must be authenticated as Workspace Owner or Staff with workspace.read permission.

Headers

Authorization: Bearer <workspace_token>
Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier
linkId	string	Yes	Tracking link identifier

Query Parameters

Parameter	Type	Required	Description
baseUrl	string	No	Base URL for generating full tracking link (must be valid URL)

Response 200 OK

{
  "link": {
    "id": "507f1f77bcf86cd799439011",
    "workspaceId": "507f1f77bcf86cd799439012",
    "type": "vcard",
    "name": "Facebook Campaign",
    "utmName": "facebook-campaign",
    "destinationSlug": "my-vcard",
    "isActive": true,
    "fullUrl": "https://example.com/vcard/my-vcard?utm_source=facebook-campaign",
    "createdAt": "2024-12-01T10:00:00.000Z",
    "updatedAt": "2024-12-01T10:00:00.000Z"
  }
}

Response Fields

See List Tracking Links for field descriptions.

Common Errors

400 Bad Request: Invalid query parameters (e.g., invalid baseUrl format)

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: User does not have workspace.read permission

404 Not Found: Workspace or tracking link not found

500 Internal Server Error: Server error occurred while processing the request