Retrieve a list of folders

Retrieve a list of folders for the authenticated workspace.

GET /folders

Python

Python

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.folders.list(request={
        "page": 1,
    })

    # Handle response
    print(res)

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "default",
    "accessLevel": null,
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Default authentication mechanism

Query Parameters

search · string

The search term to filter the folders by.

page · number

The page number for pagination.

Required range: x > 0

Example:

1

pageSize · number · default: 50

The number of items per page.

Required range: 0 < x <= 50

Example:

50

Response

200

application/json

A list of folders

id · string · required

The unique ID of the folder.

name · string · required

The name of the folder.

description · string | null · required

The description of the folder.

type · enum<string> · required

Available options: default, mega

accessLevel · enum<string> | null · required

The access level of the folder within the workspace.

Available options: write, read

createdAt · string · required

The date the folder was created.

updatedAt · string · required

The date the folder was updated.