> ## Documentation Index
> Fetch the complete documentation index at: https://learn.biq.li/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a biolink

> Retrieve one bio page's public URL, settings, and aggregate counts.

Retrieve one biolink by its public `biq_bio_...` ID. The key needs
**Biolinks: Read** with the `biolinks.view` permission.

## Request

```bash theme={null}
curl --request GET \
  --url https://biq.li/api/v1/bio/biq_bio_01M19R8Q6G4S2PT7VNZ5K0W3CX \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json'
```

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`.

```json theme={null}
{
  "biolink": {
    "id": "biq_bio_01M19R8Q6G4S2PT7VNZ5K0W3CX",
    "external_id": "creator-page-1842",
    "name": "Acme profile",
    "description": "Official links for Acme.",
    "short_url": "https://go.example.com/acme",
    "alias": "acme",
    "domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
    "active": true,
    "has_password": true,
    "activates_at": "2026-09-01T08:00:00+00:00",
    "expires_at": "2027-01-01T00:00:00+00:00",
    "allow_search_engine_indexing": false,
    "links_count": 4,
    "clicks_count": 238,
    "clicked_at": "2026-08-30T12:15:31+00:00",
    "created_at": "2026-08-30T11:42:19+00:00",
    "updated_at": "2026-08-30T12:02:08+00:00"
  },
  "status": "success"
}
```

## 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

| HTTP status | Error code            | Meaning                                                                        |
| ----------- | --------------------- | ------------------------------------------------------------------------------ |
| `401`       | `invalid_token`       | The API key is missing, invalid, or revoked.                                   |
| `403`       | `insufficient_scope`  | The key lacks `biolinks.view`, or its user cannot view pages in the workspace. |
| `404`       | `resource_not_found`  | The ID is malformed, missing, deleted, or belongs to another workspace.        |
| `429`       | `rate_limit_exceeded` | The workspace exceeded its API request limit.                                  |

## Shared API behavior

Authentication is workspace-scoped; see [Authentication](/docs/api-reference/authentication). Errors use the standard envelope and request IDs described in [Errors](/docs/api-reference/errors), and requests are subject to [Rate limits](/docs/api-reference/rate-limits).


## OpenAPI

````yaml GET /v1/bio/{bio}
openapi: 3.1.0
info:
  title: Biqli API
  version: 1.0.0
  description: Workspace-scoped REST API for Biqli.
servers:
  - url: https://biq.li/api
security:
  - bearerAuth: []
paths:
  /v1/bio/{bio}:
    parameters:
      - $ref: '#/components/parameters/BiolinkId'
    get:
      tags:
        - Biolinks
      summary: Retrieve a biolink
      description: Requires biolinks.view.
      operationId: bio.show
      responses:
        '200':
          description: Page-level settings and aggregate counts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BiolinkResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    BiolinkId:
      name: bio
      in: path
      required: true
      schema:
        type: string
        pattern: ^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$
  schemas:
    BiolinkResponse:
      type: object
      required:
        - biolink
        - status
      properties:
        biolink:
          $ref: '#/components/schemas/Biolink'
        status:
          type: string
          const: success
    Biolink:
      type: object
      additionalProperties: false
      description: >-
        Stable page-level settings and aggregate counts. Frontend-owned content,
        widgets, layout, and appearance are omitted.
      required:
        - id
        - external_id
        - name
        - description
        - short_url
        - alias
        - domain_id
        - active
        - has_password
        - activates_at
        - expires_at
        - allow_search_engine_indexing
        - links_count
        - clicks_count
        - clicked_at
        - created_at
        - updated_at
      properties:
        id:
          type: string
          pattern: ^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$
        external_id:
          type:
            - string
            - 'null'
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        short_url:
          type: string
          format: uri
        alias:
          type: string
        domain_id:
          type:
            - string
            - 'null'
          pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
        active:
          type: boolean
        has_password:
          type: boolean
        activates_at:
          type:
            - string
            - 'null'
          format: date-time
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        allow_search_engine_indexing:
          type: boolean
        links_count:
          type: integer
          minimum: 0
        clicks_count:
          type: integer
          minimum: 0
        clicked_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    ApiError:
      type: object
      required:
        - error
        - request_id
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_token
                - insufficient_scope
                - upgrade_required
                - quota_exceeded
                - resource_not_found
                - domain_taken
                - alias_taken
                - external_id_taken
                - folder_name_taken
                - tag_name_taken
                - pixel_name_taken
                - biolink_name_taken
                - method_not_allowed
                - url_blocked
                - dns_verification_failed
                - validation_error
                - rate_limit_exceeded
                - internal_server_error
            message:
              type: string
            details:
              type: object
              additionalProperties: true
        request_id:
          type: string
          description: Request identifier to include when contacting support.
  responses:
    Unauthorized:
      $ref: '#/components/responses/ApiErrorResponse'
      description: The workspace API key is missing, invalid, or revoked.
    Forbidden:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The key lacks a required scope, the workspace must upgrade, or its quota
        is exhausted.
    NotFound:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The requested resource or referenced public ID is unavailable in the
        key's workspace.
    RateLimited:
      description: The workspace exceeded its plan's API rate limit.
      headers:
        RateLimit-Policy:
          description: Current IETF HTTPAPI quota policy as a structured field.
          schema:
            type: string
            example: '"workspace-api";q=1000;w=60'
        RateLimit:
          description: Current IETF HTTPAPI service limit as a structured field.
          schema:
            type: string
            example: '"workspace-api";r=0;t=17'
        Retry-After:
          description: Seconds to wait before retrying the request.
          schema:
            type: integer
            minimum: 0
            example: 17
        X-RateLimit-Limit:
          description: Legacy maximum request count for the current window.
          schema:
            type: integer
            minimum: 1
            example: 1000
        X-RateLimit-Remaining:
          description: Legacy remaining request count.
          schema:
            type: integer
            minimum: 0
            example: 0
        X-RateLimit-Reset:
          description: Legacy reset time as a UTC Unix timestamp.
          schema:
            type: integer
            format: int64
            example: 1788126519
        X-Biq-Request-Id:
          description: Request identifier for support and tracing.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      $ref: '#/components/responses/ApiErrorResponse'
      description: The request failed unexpectedly.
    ApiErrorResponse:
      description: API error.
      headers:
        X-Biq-Request-Id:
          description: Request identifier for support and tracing.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Workspace API key
      description: A workspace API key beginning with biqli_.

````