Skip to content
FLORA FLORA API

List workspace projects

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


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


// Paginated lists are async iterables; further pages are fetched as needed.
for await (const project of await client.projects.list({
  workspace_id: 'ws_abc123',
})) {
  console.log(project);
}

Returns projects in the requested workspace, ordered by recent activity. By default these are the projects the caller created; visibility narrows to the caller’s private projects or widens to every member’s shared canvases. query filters by name.

Error responses use the standard error body.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit

Maximum number of results to return

integer
>= 1 <= 100

Maximum number of results to return

cursor

Opaque cursor for fetching the next page

string

Opaque cursor for fetching the next page

query

Search query

string

Search query

workspace_id
required

Workspace identifier

string
/^ws_\S+$/

Workspace identifier

visibility

Which projects to list. private: the caller’s private projects. workspace: canvases shared with the whole workspace, by any member. Omit for every project the caller created, private and shared alike.

string
Allowed values: private workspace

Which projects to list. private: the caller’s private projects. workspace: canvases shared with the whole workspace, by any member. Omit for every project the caller created, private and shared alike.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Projects returned.

Media type application/json
object
projects
required
Array<object>
object
project_id
required

Project identifier

string
/^prj_\S+$/
name
required

Project name

string
thumbnail_url
Any of:
string format: uri
is_private

True when only the creator sees the project, rather than the whole workspace. Absent when the API cannot tell.

boolean
workspace_id
required

Workspace identifier

string
/^ws_\S+$/
origin
required
Any of:

Project origin

string
last_modified
required
Any of:
number
created_at
required
number
meta
required
object
next_cursor
required
Any of:

Opaque cursor for fetching the next page

string
total_estimate
Any of:

Estimated total matching items

integer
Example 
{
  "projects": [
    {
      "project_id": "prj_abc123",
      "name": "Spring Campaign",
      "workspace_id": "ws_abc123",
      "origin": "api"
    }
  ],
  "meta": {
    "next_cursor": "eyJvZmZzZXQiOjIwfQ"
  }
}