Biolinks
Retrieve a biolink
Retrieve one bio page’s public URL, settings, and aggregate counts.
GET
Retrieve a biolink
Retrieve one biolink by its public
The endpoint accepts no query parameters and no request body. A valid-looking
ID from another workspace returns the same
biq_bio_... ID. The key needs
Biolinks: Read with the biolinks.view permission.
Request
404 resource_not_found response as
an ID that does not exist.
Response
Success returns200 OK.
Field notes
short_urlis the complete visitor-facing URL. Do not construct it from the alias yourself.domain_idisnullwhen the page uses the default Biqli domain.has_passwordis safe to display. Password values are never returned.links_countis the number of links currently placed on the page.clicks_countandclicked_atsummarize visits to the biolink itself.- Date-time values use ISO 8601 and are
nullwhen not set.
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
A workspace API key beginning with biqli_.
Path Parameters
Pattern:
^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$
