Skip to content
FLORA FLORA API

Get a project

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


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


const project = await client.projects.retrieve({
  projectId: '<projectId>',
});
console.log(project);

Returns metadata for a single project when it is accessible to the authenticated public API key. Missing and inaccessible projects both return 404.

Error responses use the standard error body.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required

Project identifier

string
/^prj_\S+$/

Project identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Project returned.

Media type application/json
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
Example 
{
  "project_id": "prj_abc123",
  "name": "Spring Campaign",
  "workspace_id": "ws_abc123",
  "origin": "api"
}