Skip to main content
GET

Request

string
required
Your project API key: b2co_your_api_key
string
required
The unique short code of the link to retrieve

Response

boolean
Indicates if the request was successful
object
The link object with detailed information
string
Unique short code for the link
string
Display name of the link
number
Total number of clicks on this link
Complete short URL (e.g., https://b2co.link/abc123)
The original destination URL
string
Display name of the link
string
Link status: ACTIVE, PAUSED, EXPIRED, or DELETED
string
QR code URL for the link
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when expires (if set)
number
Total number of clicks on this link
object
Complete link configuration payload with platform-specific settings
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

Error Codes

Link with the specified code does not exist
string
API key is missing or invalid
string
API key does not have access to this link
string
Too many requests, please try again later