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 that are accessible to the authenticated public API key, ordered by recent activity.

Error responses use the standard error body.

Authorizations

• bearerAuth

Parameters

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

Responses

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

workspace_id

required

Workspace identifier

string

/^ws_\S+$/

origin

required

Any of:

string

Project origin

string

null

null

last_modified

required

Any of:

number

number

null

null

created_at

required

number

meta

required

object

next_cursor

required

Any of:

string

Opaque cursor for fetching the next page

string

null

null

total_estimate

Any of:

integer

Estimated total matching items

integer

null

null

Example

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