Skip to main content
GET
Retrieve a biolink
Retrieve one biolink by its public biq_bio_... ID. The key needs Biolinks: Read with the biolinks.view permission.

Request

The endpoint accepts no query parameters and no request body. A valid-looking ID from another workspace returns the same 404 resource_not_found response as an ID that does not exist.

Response

Success returns 200 OK.

Field notes

  • short_url is the complete visitor-facing URL. Do not construct it from the alias yourself.
  • domain_id is null when the page uses the default Biqli domain.
  • has_password is safe to display. Password values are never returned.
  • links_count is the number of links currently placed on the page.
  • clicks_count and clicked_at summarize visits to the biolink itself.
  • Date-time values use ISO 8601 and are null when not set.
This resource intentionally omits widget data, appearance configuration, page layout, and content ordering. Manage those frontend-owned details in the Biqli dashboard. Use the Links API separately to retrieve or manage workspace links.

Errors

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

bio
string
required
Pattern: ^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$

Response

Page-level settings and aggregate counts.

Stable page-level settings and aggregate counts. Frontend-owned content, widgets, layout, and appearance are omitted.

status
string
required
Allowed value: "success"