Skip to content
My Docs

Creates a new project

POST
/api/v1/Project

Sample request:

POST /api/v1/Project
{
    "name": "New Project",
    "description": "Project description",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "start_date": "2024-01-01",
    "end_date": "2024-12-31",
    "status": "NotStarted"
}

Required permissions:

  • Workspace member access

Authorizations

Request Body

Project creation details

object
name
required
string
>= 3 characters <= 20 characters
description
string
nullable >= 3 characters <= 100 characters
workspaceId
required
string format: uuid
startDate
string format: date
nullable
endDate
string format: date
nullable
status
required
integer format: int32

Responses

201

Project successfully created

object
id
string format: uuid
workspaceId
string format: uuid
name
string
nullable
description
string
nullable
startDate
string format: date-time
nullable
endDate
string format: date-time
nullable
status
integer format: int32
createdDate
string format: date-time
members
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
workspaceMemberId
string format: uuid
accessLevel
integer format: int32
createdDate
string format: date-time
workspaceMember
object
id
string format: uuid
workspaceId
string format: uuid
userId
string format: uuid
accessLevel
integer format: int32
createdDate
string format: date-time
lists
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
name
string
nullable
position
integer format: int32
createdDate
string format: date-time
tasks
Array<object>
nullable
object
id
string format: uuid
projectId
string format: uuid
listId
string format: uuid
name
string
nullable
description
string
nullable
priority
integer format: int32
status
integer format: int32
deadline
string format: date-time
nullable
createdDate
string format: date-time
assignees
Array<object>
nullable
object
id
string format: uuid
taskId
string format: uuid
userId
string format: uuid
assignedDate
string format: date-time
user
object
id
string format: uuid
username
string
nullable
name
string
nullable
email
string
nullable
createdDate
string format: date-time
accessLevel
integer format: int32
comments
Array<object>
nullable
object
id
string format: uuid
taskId
string format: uuid
userId
string format: uuid
content
required
string
nullable
createdDate
string format: date-time
user
object
id
string format: uuid
username
string
nullable
name
string
nullable
email
string
nullable
createdDate
string format: date-time
accessLevel
integer format: int32
list
object recursive
project
object recursive

400

Invalid project data or user ID is null

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties

403

User is not a member of the workspace

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties