Skip to main content
GET
List folders
GET /v1/folder requires Folders: Read (link_groups.view). Results are newest first.
Query parameters are search, active, page_size (1100, default 50), starting_after, and ending_before. Cursors are returned biq_fld_... IDs; do not construct them or send both cursor directions. The response contains folders with complete safe folder resources and pagination with page_size, has_more, next_cursor, and previous_cursor. No matches returns an empty array with 200 OK.

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

Folder list.

folders
object[]
required
pagination
object
required
status
string
required
Allowed value: "success"