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

# List biolinks

> List, search, filter, and paginate bio pages in the API key's workspace.

List biolinks in the workspace bound to your API key. The key needs
**Biolinks: Read** with the `biolinks.view` permission.

Each item uses the same complete page-level format returned by
[Retrieve a biolink](/docs/api-reference/biolinks/get). Widget data, appearance, and
content ordering are not included.

## Basic request

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

## Query parameters

| Parameter        | Type    | Default | Behavior                                                                          |
| ---------------- | ------- | ------- | --------------------------------------------------------------------------------- |
| `search`         | string  | —       | Searches name, description, alias, and external ID. Between 1 and 255 characters. |
| `active`         | boolean | —       | Filters by active state. Use `1` for active or `0` for inactive.                  |
| `page_size`      | integer | `50`    | Number of results to return. Minimum `1`, maximum `100`.                          |
| `starting_after` | string  | —       | Returns the next page after a `biq_bio_...` cursor.                               |
| `ending_before`  | string  | —       | Returns the previous page before a `biq_bio_...` cursor.                          |

`starting_after` and `ending_before` are mutually exclusive. Unknown query
parameters return `422 validation_error`.

## Search and filter example

```bash theme={null}
curl --request GET \
  --url 'https://biq.li/api/v1/bio?search=acme&active=1&page_size=20' \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json'
```

Search treats `%` and `_` as literal characters rather than SQL wildcards.
Results are ordered newest first using creation time and ID as a stable
tie-breaker.

## Response

```json theme={null}
{
  "biolinks": [
    {
      "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": false,
      "activates_at": null,
      "expires_at": null,
      "allow_search_engine_indexing": true,
      "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"
    }
  ],
  "pagination": {
    "page_size": 20,
    "has_more": true,
    "next_cursor": "biq_bio_01M18ZQG6Y2S0MNP4C8XKJ7DTV",
    "previous_cursor": null
  },
  "status": "success"
}
```

An empty result is successful and returns `biolinks: []` with null cursors.

## Forward pagination

1. Make the first request without a cursor.
2. Read `pagination.next_cursor`.
3. When it is not null, pass it as `starting_after` with the same filters.
4. Stop when `next_cursor` is null.

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

Use `ending_before` with `previous_cursor` to navigate in the opposite
direction. Cursors are resource IDs, but treat them as opaque pagination tokens
and do not calculate or modify them.

If a well-formed cursor is missing or outside the API key's workspace, the API
returns `404 resource_not_found`. A malformed cursor returns
`422 validation_error`.

## 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 workspace pages. |
| `404`       | `resource_not_found`  | A supplied pagination cursor is unavailable in this workspace.          |
| `422`       | `validation_error`    | A filter is invalid, unsupported, or conflicts with another filter.     |
| `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). This endpoint uses cursor pagination; see [Pagination](/docs/api-reference/pagination).


## OpenAPI

````yaml GET /v1/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:
    get:
      tags:
        - Biolinks
      summary: List biolinks
      description: >-
        Lists page-level settings and aggregate counts. Widget, content, layout,
        and appearance data are not exposed. Requires biolinks.view.
      operationId: bio.index
      parameters:
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/Active'
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/StartingAfter'
        - $ref: '#/components/parameters/EndingBefore'
      responses:
        '200':
          description: Biolink list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BiolinkListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Search:
      name: search
      in: query
      schema:
        type: string
        minLength: 1
        maxLength: 255
    Active:
      name: active
      in: query
      schema:
        type: boolean
    PageSize:
      name: page_size
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    StartingAfter:
      name: starting_after
      in: query
      description: Next-page public ID cursor; mutually exclusive with ending_before.
      schema:
        type: string
    EndingBefore:
      name: ending_before
      in: query
      description: Previous-page public ID cursor; mutually exclusive with starting_after.
      schema:
        type: string
  schemas:
    BiolinkListResponse:
      type: object
      required:
        - biolinks
        - pagination
        - status
      properties:
        biolinks:
          type: array
          items:
            $ref: '#/components/schemas/Biolink'
        pagination:
          $ref: '#/components/schemas/CursorPagination'
        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
    CursorPagination:
      type: object
      additionalProperties: false
      required:
        - page_size
        - has_more
        - next_cursor
        - previous_cursor
      properties:
        page_size:
          type: integer
          minimum: 1
          maximum: 100
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
        previous_cursor:
          type:
            - string
            - 'null'
    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.
    UnprocessableEntity:
      $ref: '#/components/responses/ApiErrorResponse'
      description: >-
        The payload is invalid, a destination was blocked, or domain DNS
        verification is not ready.
    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_.

````