Get Link Details

Overview

Fetch comprehensive information about a specific dynamic link using its unique code. This endpoint returns all link details including configuration, analytics, and current status.

Endpoint

GET https://api.bit2connect.com/1.0/links/{code}

X-API-KEY: b2co_your_api_key_here

Path Parameters

For detailed information about path parameters, see the Get Link API Reference.

Example Request

curl -X GET "https://api.bit2connect.com/1.0/links/summer-sale" \
  -H "X-API-KEY: b2co_your_api_key_here"

const code = "summer-sale";
const response = await fetch(`https://api.bit2connect.com/1.0/links/${code}`, {
  headers: {
    "X-API-KEY": "b2co_your_api_key_here",
  },
});

const data = await response.json();
console.log("Link details:", data.data);

import requests

code = "summer-sale"
url = f"https://api.bit2connect.com/1.0/links/{code}"
headers = {
    "X-API-KEY": "b2co_your_api_key_here"
}

response = requests.get(url, headers=headers)
data = response.json()

print(f"Link: {data['data']['name']}")
print(f"URL: {data['data']['shortUrl']}")
print(f"Clicks: {data['data']['clickCount']}")

Response

Success Response

{
  "success": true,
  "data": {
    "id": "clp123abc456",
    "code": "summer-sale",
    "shortUrl": "https://b2co.link/summer-sale",
    "originalUrl": "https://example.com/products/summer-sale",
    "name": "Summer Sale Campaign",
    "status": "ACTIVE",
    "qrCode": "https://b2co.link/summer-sale/qr",
    "payload": {
      "link": "https://example.com/products/summer-sale",
      "android": {
        "package": "com.example.app",
        "store_fallback": "https://play.google.com/store/apps/details?id=com.example.app"
      },
      "ios": {
        "bundleId": "com.example.app",
        "app_store_fallback": "https://apps.apple.com/app/example-app/id123456789"
      },
      "social": {
        "title": "Summer Sale - Up to 50% Off!",
        "description": "Don't miss our biggest sale of the year",
        "image": "https://example.com/images/summer-sale.jpg"
      },
      "campaign": {
        "utm_source": "api",
        "utm_medium": "dynamic_link",
        "utm_campaign": "summer_sale_2024"
      }
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "expiresAt": "2024-12-31T23:59:59Z",
    "clickCount": 127,
    "analytics": {
      "totalClicks": 127,
      "uniqueClicks": 89,
      "clicksByPlatform": {
        "ios": 45,
        "android": 38,
        "web": 44
      },
      "clicksByCountry": {
        "US": 67,
        "CA": 23,
        "GB": 18,
        "other": 19
      }
    }
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Error Response

{
  "success": false,
  "error": {
    "code": "LINK_NOT_FOUND",
    "message": "Link with the specified code was not found"
  }
}

For detailed response fields, error codes, and use cases, see the Get Link API Reference.

Next Steps

Update Link Status

Change the status of your link (active, paused, archived)

Delete Link

Permanently remove the link from your project

List Links

View all your dynamic links with filtering options

Check Code Availability

Verify if a code is available before creating a new link

Getting started

Mobile SDKs

API Guides

Mobile Apps

Overview

Endpoint

Path Parameters

Example Request

Response

Success Response

Error Response

Next Steps

Update Link Status

Delete Link

List Links

Check Code Availability

​Overview

​Endpoint

​Path Parameters

​Example Request

​Response

​Success Response

​Error Response

​Next Steps

Update Link Status

Delete Link

List Links

Check Code Availability

Overview

Endpoint

Path Parameters

Example Request

Response

Success Response

Error Response

Next Steps