Skip to main content
GET
Retrieve a link
Retrieve one short link from the workspace bound to your API key. Pass the public biq_lnk_... ID returned when you created or listed the link.

Authentication and permission

Send a workspace API key with Links: Read (links.view). That permission is enough to read the link configuration and its aggregate click, lead, sales, and revenue values. You do not need a separate analytics permission.
You do not send a workspace ID. The API key determines the workspace, and the endpoint never falls back to an internal numeric link ID.

Request

Response

The endpoint returns the same complete link resource used by create and update, plus current aggregate performance values.

Configuration fields

Performance fields

All date-time values use ISO 8601. Nullable settings are returned as null, and unattached resource lists are returned as empty arrays.

Errors

Errors include an error object and a traceable request_id. The same request ID is returned in the X-Biq-Request-Id response header.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Path Parameters

Public link ID.

Pattern: ^biq_lnk_[0-9A-HJKMNP-TV-Z]{26}$

Response

Link returned successfully.

status
string
required
Allowed value: "success"