Skip to main content
GET
List biolinks
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. Widget data, appearance, and content ordering are not included.

Basic request

Query parameters

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

Search and filter example

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

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

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. This endpoint uses cursor pagination; see Pagination.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Query Parameters

Required string length: 1 - 255
active
boolean
page_size
integer
default:50
Required range: 1 <= x <= 100
starting_after
string

Next-page public ID cursor; mutually exclusive with ending_before.

ending_before
string

Previous-page public ID cursor; mutually exclusive with starting_after.

Response

Biolink list.

pagination
object
required
status
string
required
Allowed value: "success"