API Reference

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get project

client.projects.retrieve(stringid, RequestOptionsoptions?): ProjectRetrieveResponse { id, created_at, name, 5 more }

GET/api/projects/{id}/

Get project

ParametersExpand Collapse

id: string

formatuuid

ReturnsExpand Collapse

ProjectRetrieveResponse { id, created_at, name, 5 more }

id: string

formatuuid

created_at: string

formatdate-time

name: string

maxLength255

slug: string

maxLength255

updated_at: string

formatdate-time

description?: string

is_active?: boolean

settings?: unknown

Get project

TypeScript

HTTP

TypeScript

Python

import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const project = await client.projects.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(project.id);

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "is_active": true,
  "settings": {}
}

Returns Examples

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "is_active": true,
  "settings": {}
}