Check Code Availability

Overview

Check if a custom short code is available for use in your project. This endpoint helps you verify code availability before creating a new dynamic link, preventing conflicts and ensuring your preferred codes are available.

Endpoint

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

X-API-KEY: b2co_your_api_key_here

Path Parameters

For detailed information about path parameters, see the Check Code Availability API Reference.

Example Request

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

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

const data = await response.json();
console.log(`Code "${code}" available:`, data.data.available);

import requests

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

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

if data['data']['available']:
    print(f"✅ Code '{code}' is available!")
else:
    print(f"❌ Code '{code}' is not available")

Response

Available Code Response

{
  "success": true,
  "data": {
    "code": "summer-sale-2024",
    "available": true
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Unavailable Code Response

{
  "success": true,
  "data": {
    "code": "summer-sale",
    "available": false,
    "message": "Code is already in use in this project"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_CODE_FORMAT",
    "message": "Code must be 3-50 characters and contain only alphanumeric characters, hyphens, and underscores"
  }
}

For detailed response fields, error codes, code requirements, and workflow integration examples, see the Check Code Availability API Reference.

Next Steps

Create Link

Create a new dynamic link with your verified code

List Links

View all your existing dynamic links

Get Link Details

Check details of existing links

Update Link Status

Manage your link statuses

Getting started

Mobile SDKs

API Guides

Mobile Apps

Overview

Endpoint

Path Parameters

Example Request

Response

Available Code Response

Unavailable Code Response

Error Response

Next Steps

Create Link

List Links

Get Link Details

Update Link Status

​Overview

​Endpoint

​Path Parameters

​Example Request

​Response

​Available Code Response

​Unavailable Code Response

​Error Response

​Next Steps

Create Link

List Links

Get Link Details

Update Link Status

Overview

Endpoint

Path Parameters

Example Request

Response

Available Code Response

Unavailable Code Response

Error Response

Next Steps