GET
/
folders
from dub import Dub


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

    res = d_client.folders.list(request={})

    assert res is not None

    # Handle response
    print(res)
[
  {
    "id": "<string>",
    "name": "<string>",
    "type": "default",
    "accessLevel": null,
    "linkCount": 0,
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
search
string

The search term to filter the folders by.

​
includeLinkCount
boolean

Whether to include the link count in the response.

​
page
number
default:1

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.

​
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
​
linkCount
number
default:0
required

The number of links in the folder.

​
createdAt
string
required

The date the folder was created.

​
updatedAt
string
required

The date the folder was updated.