Skip to content
My Docs

Creates a new list in a project

POST
/api/v1/Project/{projectId}/lists

Sample request:

POST /api/v1/Project/{projectId}/lists
{
    "name": "New List",
    "tasks": [
        {
            "name": "Task 1",
            "description": "Task description",
            "status": "ToDo",
            "priority": "Medium"
        }
    ]
}

Required permissions:

  • Project member access

Authorizations

Parameters

Path Parameters

projectId
required
string format: uuid

The unique identifier of the project

Request Body

List creation details

object
name
required
string
>= 3 characters <= 100 characters
tasks
Array<object>
nullable
object
name
required
string
>= 3 characters <= 100 characters
description
string
nullable >= 3 characters <= 100 characters
status
required
integer format: int32
priority
integer format: int32
deadline
string format: date-time
nullable
projectId
required
string format: uuid
listId
required
string format: uuid

Responses

201

List successfully created

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
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> recursive

400

Invalid list 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 project member

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

404

Project not found

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