Skip to main content
GET
Count links
Return the number of links that match a set of filters without downloading the link resources. This is useful for dashboards, import previews, and deciding how many List links pages you need to request.

Authentication and permission

This endpoint only requires Links: Read (links.view):
The API key determines the workspace, so do not send a workspace ID. The count also follows the key owner’s current workspace role and therefore always covers the same visible links as the List endpoint.
A count of zero is a successful 200 OK response.

Filter the count

Count supports every non-pagination List filter. Combined filters use AND; multiple tag_ids match a link that has any supplied tag. page_size, starting_after, and ending_before are intentionally not accepted because counting is not paginated. Unknown query parameters return 422 validation_error.
Use the identical filters with GET /v1/link to retrieve those links.

Errors

Validation errors identify fields under error.details.errors. Every error includes a request_id for support and request tracing.

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

Query Parameters

Required string length: 1 - 255
domain_id
string
Pattern: ^(default|biq_dom_[0-9A-HJKMNP-TV-Z]{26})$
folder_id
string
Pattern: ^biq_fld_[0-9A-HJKMNP-TV-Z]{26}$
tag_ids
string[]
Required array length: 1 - 100 elements
Pattern: ^biq_tag_[0-9A-HJKMNP-TV-Z]{26}$
external_id
string
Required string length: 1 - 255
active
boolean
safety_status
enum<string>
Available options:
clear,
pending,
quarantined

Response

Count returned successfully.

count
integer
required
Required range: x >= 0
status
string
required
Allowed value: "success"