Skip to main content
GET
https://api.taap.it
/
v1
/
links
/
{link_id}
Retrieve Link
curl --request GET \
  --url https://api.taap.it/v1/links/{link_id} \
  --header 'Authorization: <authorization>'
Get detailed information about a specific link by its ID. Request:
cURL
curl -X GET 'https://api.taap.it/v1/links/link_987654321' \
  -H 'Authorization: Bearer taapit_your_api_key_here'
Response:
{
  "id": "link_987654321",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "project_id": "project_123456789",
  "domain_id": "domain_987654321",
  "pixel_id": "pixel_456789123",
  "original_url": "https://example.com/very-long-url-that-needs-shortening",
  "name": "My Marketing Link",
  "description": "Link for summer campaign",
  "code": "my-custom-link",
  "app": "MyApp",
  "app_logo": "https://example.com/logo.png",
  "android_link": "myapp://open?url=https://example.com",
  "ios_link": "myapp://open?url=https://example.com",
  "windows_link": "ms-windows-store://pdp/?productid=9NBLGGH123456",
  "macos_link": "macappstore://itunes.apple.com/app/myapp/id123456789",
  "whatsapp_message": "Check out this amazing link!",
  "metadata": {
    "title": "Amazing Product",
    "description": "Check out our new product",
    "favicon": "https://example.com/favicon.ico",
    "social_image": "https://example.com/social-image.jpg"
  },
  "qr_code_options": {
    "size": 200,
    "color": "#000000",
    "background_color": "#ffffff",
    "logo": "https://example.com/logo.png",
    "logo_size": 50,
    "error_correction_level": "M"
  },
  "utm_name": "summer_campaign",
  "utm_source": "email",
  "utm_medium": "newsletter",
  "utm_campaign": "summer2024",
  "utm_term": "marketing",
  "utm_content": "cta_button",
  "utm_template_id": "template_123",
  "referrer": "https://example.com",
  "password": "secure123",
  "password_description": "Enter password to access link",
  "excluded_countries": [
    {
      "code": "US",
      "label": "United States",
      "phone": "+1",
      "suggested": true,
      "lang": "en",
      "continent": "North America"
    }
  ],
  "has_public_stat": true,
  "is_archived": false,
  "expiration_date": "2024-12-31T23:59:59Z",
  "expiration_click_count": 1000,
  "clicks": 42
}

Authorization

Authorization
string
required
Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Path Parameters

Unique identifier for the link