Overview
Projects let you manage teams and tasks within your Workspace.
Endpoints
POST /api/v1/workspaces/:workspace-slug/projects/
GET /api/v1/workspaces/:workspace-slug/projects/
GET /api/v1/workspaces/:workspace-slug/projects/:project_id/
PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/
DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/
Project Object
Attributes
-
name
string (required)Name of the project
-
identifier
string (required)Unique Identifier of project for the workspace
-
description
stringProject description
-
total_members
integerTotal members present in the project.
-
total_cycles
integerTotal number of cycles present in the project.
-
total_modules
integerTotal number of modules present in the project.
-
is_member
booleanThe current requesting user is a member of the project or not
-
member_role
integerThe current requesting users role in the project.
-
is_deployed
integerRepresents if the project is deployed and publicly visible.
-
created_at
timestampThe timestamp of the time when the project was created
-
updated_at
timestampThe timestamp of the time when the project was last updated
-
network
integerIs the project public or secret it takes in two values either (0,2)
- 0 - Secret
- 2 - Public
-
emoji
stringHTML emoji DEX code without the
&#
-
icon_prop
jsonsaves the data of the project icon
-
module_view
boolEnable disable module for the project in the UI
-
cycle_view
boolEnable disable cycle for the project in the UI
-
inbox_view
boolEnable disable inbox for the project in the UI
-
page_view
boolEnable disable pages for the project in the UI
-
issue_views_view
boolEnable disable project views for the project in the UI
-
cover_image
urlURL for the image for the project cover
-
archive_in
integerMonths in which the issue should be automatically archived can take values between (0,12)
-
close_in
integerMonths in which the issue should be auto closed can take values between (0,12)
-
created_by
,updated_by
uuidThis values are auto saved and represent the id of the user that created or the updated the project
-
workspace
uuidThe workspace uuid where the project is created saved automatically
-
default_assignee
uuidThe uuid of the user who is a workspace member that have issues assigned automatically if the issue does not have any assignee
-
project_lead
uuidThe uuid of the user who is a workspace member that leads the project
-
estimate
uuidUUID of the estimate of the project
-
default_state
Default state which will be used when the issues will be auto closed
Response Object