Skip to main content
GET
List folders

Authorizations

Authorization
string
header
required

Workspace-scoped API key, sent as a bearer token. The recommended header. The workspace is implicit in the key and never appears in a URL.

Query Parameters

limit
number
default:100

Maximum items in one page. A page may come back shorter; read hasMore, not the count.

Required range: 1 <= x <= 1000
cursor
string

A nextCursor from an earlier page. Opaque: store and echo it, never parse or construct one. A cursor belongs to the query that issued it, so changing a filter means starting again from the first page; reusing one across filters answers invalid_cursor rather than a page from the wrong collection.

path
string

Exact path to a folder. A path naming nothing is an empty collection. The root itself is not addressable here; omit every selector to list root folders.

Example:

"/support/policies"

path_prefix
string

Every folder below this folder, recursively. A prefix naming nothing is an empty collection.

Example:

"/support"

parent_id
string

Lists folders directly inside this parent. Omit it to list root folders.

Example:

"dir_9f2k1x8b3m7q0v"

Response

A page of folders. Read hasMore before stopping.

object
enum<string>
required

Type discriminator. Always list.

Available options:
list
url
string
required

The collection this page came from, without the query that selected it.

Example:

"/v1/files"

hasMore
boolean
required

Whether more items remain. A short page does not mean the end: unreadable items are dropped after the page is read. Page until this is false.

nextCursor
string | null
required

Opaque. Pass back as cursor. Present whenever hasMore is true, null on the last page.

Example:

"c_9f2k1x8b3m7q0v"

data
object[]
required

The folders on this page.