Overview

Projects organize your team's work within a workspace. Each project contains work items, cycles, modules, and other resources.

Learn more about projects

The project object

Attributes

• name string (required)

  Name of the project

• identifier string (required)

  Short identifier for the project, unique within the workspace

• description string

  Project description

• total_members integer

  Number of members in the project.

• total_cycles integer

  Number of cycles in the project.

• total_modules integer

  Number of modules in the project.

• is_member boolean

  Whether the requesting user is a member of the project

• member_role integer

  The requesting user's role in the project.

• is_deployed integer

  Whether the project is deployed and publicly visible.

• created_at timestamp

  When the project was created

• updated_at timestamp

  When the project was last updated

• network integer

  Whether the project is secret or public. Takes one of two values:

  • 0: Secret
  • 2: Public

• emoji string

  HTML emoji code, without the leading &#

• icon_prop json

  Data for the project icon

• module_view bool

  Whether modules are enabled for the project in the UI

• cycle_view bool

  Whether cycles are enabled for the project in the UI

• inbox_view bool

  Whether intake is enabled for the project in the UI

• page_view bool

  Whether pages are enabled for the project in the UI

• issue_views_view bool

  Whether project views are enabled for the project in the UI

• cover_image url

  URL of the project's cover image

• archive_in integer

  Number of months after which work items are archived automatically. Takes values between 0 and 12.

• close_in integer

  Number of months after which work items are closed automatically. Takes values between 0 and 12.

• created_by , updated_by uuid

  IDs of the users who created and last updated the project. Set automatically.

• workspace uuid

  ID of the workspace the project belongs to. Set automatically.

• default_assignee uuid

  ID of the workspace member who is assigned work items automatically when they have no assignee

• project_lead uuid

  ID of the workspace member who leads the project

• estimate uuid

  UUID of the estimate of the project

• default_state

  The state work items move to when they are closed automatically

• template_id uuid

  UUID of the project template used to create this project.

Response200

{
  "id": "00918ea1-52f7-48bd-abe3-d3efe76ff7dd",
  "total_members": 1,
  "total_cycles": 0,
  "total_modules": 0,
  "is_member": true,
  "member_role": 20,
  "is_deployed": false,
  "created_at": "2023-11-19T10:40:15.426652Z",
  "updated_at": "2023-11-19T10:40:15.426672Z",
  "name": "Project X",
  "description": "",
  "description_text": null,
  "description_html": null,
  "network": 2,
  "identifier": "PROJX",
  "emoji": null,
  "icon_prop": null,
  "module_view": true,
  "cycle_view": true,
  "issue_views_view": true,
  "page_view": true,
  "inbox_view": false,
  "cover_image": null,
  "archive_in": 0,
  "close_in": 0,
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "default_assignee": null,
  "project_lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "estimate": null,
  "default_state": null
}