Skip to main content
GET
Retrieve a folder
GET /v1/folder/{folder_id} requires Folders: Read (link_groups.view). Use a biq_fld_... ID.
The 200 OK response contains folder.id, name, description, short_url, alias, domain_id, active, rotator, has_password, scheduling and UTM settings, targeting rules, tag_ids, pixel_ids, links_count, clicks_count, clicked_at, created_at, and updated_at. It never exposes numeric IDs or password data. A missing, malformed, deleted, or cross-workspace ID returns 404 resource_not_found.

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

Path Parameters

folder
string
required
Pattern: ^biq_fld_[0-9A-HJKMNP-TV-Z]{26}$

Response

Complete folder.

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