List project folders
List project folders with the FLORA API: GET /workspaces/{workspaceId}/folders.
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.
GET https://app.flora.ai/api/v1/workspaces/{workspaceId}/foldersAuth: API key as a bearer token,
Authorization: Bearer $FLORA_API_KEY. See Authentication.TypeScript SDK:
client.workspaces.folders.list().Operation ID:
listWorkspaceFolders.
Example
curl -X GET 'https://app.flora.ai/api/v1/workspaces/ws_abc123/folders' \
-H "Authorization: Bearer $FLORA_API_KEY"import { FloraClient } from '@flora-ai/flora';
const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });
const page = await client.workspaces.folders.list({
workspaceId: 'ws_abc123',
});
console.log(page);Path parameters
workspaceId
string
Yes
Workspace identifier. Pattern: ^ws_\S+$. Example: ws_abc123.
Responses
200: Folders returned.
folders
array of objects
Yes
folders[].folder_id
string
Yes
Project folder identifier. Pattern: ^fld_\S+$. Example: fld_abc123.
folders[].name
string
Yes
Folder name. Example: FLORA Agent.
folders[].workspace_id
string
Yes
Workspace identifier. Pattern: ^ws_\S+$. Example: ws_abc123.
folders[].total_projects
integer
Yes
Number of projects filed in this folder
Errors
Every error has the same body: error.code, error.message, and error.fields on validation errors. See Errors for how to recover from each code.
400
invalid_json, input_validation_error
The body isn't valid JSON, or an input failed validation (fields lists each one).
401
unauthorized, invalid_api_key
The API key is missing, invalid or revoked.
402
insufficient_credits
The workspace balance is too low for this request.
403
forbidden, paid_plan_required
The key can't do this, or the workspace plan doesn't include it.
404
not_found
The resource doesn't exist or isn't visible to this key.
409
idempotency_duplicate, revision_conflict
Duplicate Idempotency-Key or a stale base_revision.
429
rate_limited
Too many requests. Back off and retry.
500
unknown_error, internal_error
Something failed on FLORA's side. Retry with backoff.
503
temporarily_unavailable
Authorization is temporarily unavailable. Retry later.
Last updated
Was this helpful?