Skip to content
My Docs

Retrieves a project by its ID

GET
/api/v1/Project/{projectId}

Required permissions:

  • Project member access, or
  • Admin access

Authorizations

Parameters

Path Parameters

projectId
required
string format: uuid

The unique identifier of the project

Responses

200

Returns the requested 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>
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

User ID is null

403

User does not have access to this project

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