List project folders

GET

/workspaces/{workspaceId}/folders

import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

const page = await client.workspaces.folders.list({
  workspaceId: '<workspaceId>',
});
console.log(page);

Lists the workspace’s shared project folders in workspace order. Shared folders only — private folders are never returned, matching what POST /workspaces/{workspace_id}/folders will resolve or create. Use this to choose an existing folder before filing projects with POST /workspaces/{workspace_id}/folders/{folder_id}/projects.

Error responses use the standard error body.

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

Workspace identifier

string

/^ws_\S+$/

Workspace identifier

Responses

200

Folders returned.

Media type application/json

object

folders

required

Array<object>

object

folder_id

required

Project folder identifier

string

/^fld_\S+$/

name

required

Folder name

string

workspace_id

required

Workspace identifier

string

/^ws_\S+$/

total_projects

required

Number of projects filed in this folder

integer

Example

{
  "folders": [
    {
      "folder_id": "fld_abc123",
      "name": "FLORA Agent",
      "workspace_id": "ws_abc123"
    }
  ]
}