Projects endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/workspaces/{workspaceId}/projects

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none

POST /api/workspaces/{workspaceId}/projects

Parameter	In	Type	Required
workspaceId	path	string (uuid)	yes

Request body (application/json): CreateProjectRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
description	string or null	yes

Status	Meaning	Body
200	OK	none

GET /api/projects/{projectId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	ProjectDetailDto

PATCH /api/projects/{projectId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): UpdateProjectRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes

Status	Meaning	Body
200	OK	none

DELETE /api/projects/{projectId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none