Retrieve a list of folders

Retrieve a list of folders for the authenticated workspace.

GET /folders

PHP

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();



$response = $sdk->folders->list(
    page: 1,
    pageSize: 50

);

if ($response->folderSchemas !== null) {
    // handle response
}

package main

import(
	"context"
	dubgo "github.com/dubinc/dub-go"
	"github.com/dubinc/dub-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := dubgo.New(
        dubgo.WithSecurity("DUB_API_KEY"),
    )

    res, err := s.Folders.List(ctx, operations.ListFoldersRequest{
        Page: dubgo.Pointer[float64](1.0),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

require 'dub'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
  security: Models::Shared::Security.new(
    token: 'DUB_API_KEY'
  )
)

req = Models::Operations::ListFoldersRequest.new(
  page: 1.0
)
res = s.folders.list(request: req)

unless res.nil?
  # handle response
end

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
});

async function run() {
  const result = await dub.folders.list();

  console.log(result);
}

run();

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)

curl --request GET \
  --url https://api.dub.co/folders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dub.co/folders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.get("https://api.dub.co/folders")
  .header("Authorization", "Bearer <token>")
  .asString();

200

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

{
  "error": {
    "code": "bad_request",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#not-found"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#conflict"
  }
}

{
  "error": {
    "code": "invite_expired",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
  }
}

{
  "error": {
    "code": "internal_server_error",
    "message": "The requested resource was not found.",
    "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
  }
}

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.