List Links - Bit2Connect API

GET

1.0

links

curl -X GET "https://api.bit2connect.com/1.0/links?page=1&pageSize=20" \
  -H "X-API-KEY: b2co_your_api_key"

const response = await fetch(
  "https://api.bit2connect.com/1.0/links?page=1&pageSize=20",
  {
    headers: {
      "X-API-KEY": "b2co_your_api_key",
    },
  }
);

const data = await response.json();

import requests

url = "https://api.bit2connect.com/1.0/links"
headers = {"X-API-KEY": "b2co_your_api_key"}
params = {
    "page": 1,
    "pageSize": 20
}

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

{
  "success": true,
  "data": [
    {
      "id": "clp123abc456",
      "code": "summer-sale",
      "shortUrl": "https://b2co.link/summer-sale",
      "name": "Summer Sale Campaign",
      "status": "ACTIVE",
      "qrCode": "https://b2co.link/summer-sale/qr",
      "payload": {
        "link": "https://example.com/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",
      "expiresAt": "2024-12-31T23:59:59Z",
      "clickCount": 1247,
      "qrCode": "https://b2co.link/summer-sale/qr",
      "projectId": "proj_abc123",
      "createdBy": "user_xyz789",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 45,
    "totalPages": 3
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid page size. Maximum allowed is 100."
  }
}

Request

string

required

Your project API key: b2co_your_api_key

number

default:"1"

Page number for pagination (starts from 1)

number

default:"50"

Number of links per page (maximum 100)

Response

boolean

Indicates if the request was successful

array

Array of link objects with complete payload structure

string

Unique identifier for the link

string

Unique short code for the link

string

Complete short URL (e.g., https://b2co.link/abc123)

string

Display name of the link

string

Link status: ACTIVE, PAUSED, or EXPIRED

object

Complete link configuration payload

string

Primary destination URL

object

Android-specific configuration (optional)

object

iOS-specific configuration (optional)

Social media preview configuration (optional)

string

Unique identifier for the link

string

Unique short code for the link

string

Complete short URL (e.g., https://b2co.link/abc123)

string

Display name of the link

string

Link status: ACTIVE, PAUSED, or EXPIRED

string

QR code URL for the link

object

Complete link configuration payload

string

Primary destination URL

object

Android-specific configuration (optional)

object

iOS-specific configuration (optional)

Social media preview configuration (optional)

object

UTM campaign parameters (optional)

string

ISO 8601 timestamp when created

string

ISO 8601 timestamp when expires (if set)

number

Total number of clicks on this link

string

ID of the project this link belongs to

string

ID of the user who created the link

string

ISO 8601 timestamp when last updated

object

Pagination metadata

number

Current page number

number

Number of items per page

number

Total number of links

number

Total number of pages

curl -X GET "https://api.bit2connect.com/1.0/links?page=1&pageSize=20" \
  -H "X-API-KEY: b2co_your_api_key"

const response = await fetch(
  "https://api.bit2connect.com/1.0/links?page=1&pageSize=20",
  {
    headers: {
      "X-API-KEY": "b2co_your_api_key",
    },
  }
);

const data = await response.json();

import requests

url = "https://api.bit2connect.com/1.0/links"
headers = {"X-API-KEY": "b2co_your_api_key"}
params = {
    "page": 1,
    "pageSize": 20
}

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

{
  "success": true,
  "data": [
    {
      "id": "clp123abc456",
      "code": "summer-sale",
      "shortUrl": "https://b2co.link/summer-sale",
      "name": "Summer Sale Campaign",
      "status": "ACTIVE",
      "qrCode": "https://b2co.link/summer-sale/qr",
      "payload": {
        "link": "https://example.com/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",
      "expiresAt": "2024-12-31T23:59:59Z",
      "clickCount": 1247,
      "qrCode": "https://b2co.link/summer-sale/qr",
      "projectId": "proj_abc123",
      "createdBy": "user_xyz789",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 45,
    "totalPages": 3
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid page size. Maximum allowed is 100."
  }
}

Error Codes

string

Invalid query parameters provided

string

API key is missing or invalid

string

Too many requests, please try again later

Get LinkRetrieve detailed information about a specific dynamic link by its code

curl -X GET "https://api.bit2connect.com/1.0/links?page=1&pageSize=20" \
  -H "X-API-KEY: b2co_your_api_key"

const response = await fetch(
  "https://api.bit2connect.com/1.0/links?page=1&pageSize=20",
  {
    headers: {
      "X-API-KEY": "b2co_your_api_key",
    },
  }
);

const data = await response.json();

import requests

url = "https://api.bit2connect.com/1.0/links"
headers = {"X-API-KEY": "b2co_your_api_key"}
params = {
    "page": 1,
    "pageSize": 20
}

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

{
  "success": true,
  "data": [
    {
      "id": "clp123abc456",
      "code": "summer-sale",
      "shortUrl": "https://b2co.link/summer-sale",
      "name": "Summer Sale Campaign",
      "status": "ACTIVE",
      "qrCode": "https://b2co.link/summer-sale/qr",
      "payload": {
        "link": "https://example.com/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",
      "expiresAt": "2024-12-31T23:59:59Z",
      "clickCount": 1247,
      "qrCode": "https://b2co.link/summer-sale/qr",
      "projectId": "proj_abc123",
      "createdBy": "user_xyz789",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 45,
    "totalPages": 3
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid page size. Maximum allowed is 100."
  }
}

​Request

​Response

​Error Codes

Request

Response

Error Codes