List projects

List known projects.

GET/api/project

Responses

200Success

Array of Project

idstringrequired

worktreestringrequired

vcsProject.Vcs

Allowed:githg

namestring

iconProject.Icon

Show properties

urlstring

overridestring

colorstring

commandsProject.Commands

Show properties

startstring

Startup script to run when creating a new workspace (worktree)

timeProject.Timerequired

Show properties

createdobjectrequired

Show properties

object

updatedobjectrequired

Show properties

object

initializedobject

Show properties

object

sandboxesstring[]required

400InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

Request

curl -X GET "/api/project"

const response = await fetch("/api/project", {
  method: "GET"
});

import requests

response = requests.get(
    "/api/project",
)

Response

[
  {
    "id": "string",
    "worktree": "string",
    "vcs": "git",
    "name": "string",
    "icon": {
      "url": "string",
      "override": "string",
      "color": "string"
    },
    "commands": {
      "start": "string"
    },
    "time": {
      "created": {},
      "updated": {},
      "initialized": {}
    },
    "sandboxes": [
      "string"
    ]
  }
]