Overview

Modules are smaller, focused projects that group issues within a specific time frame. Use them to break work into manageable chunks and track progress toward specific goals.

Learn more about modules

The module object

Attributes

• name string(required)

  Name of the module

• description string

  Description of the module

• description_html string

  Description in HTML format

• start_date date

  Start date of the module

• target_date date

  Estimated date to complete the module

• created_at timestamp

  When the module was created

• updated_at timestamp

  When the module was last updated

• status

  The status of the module, one of:

  • backlog
  • planned
  • in-progress
  • paused
  • completed
  • cancelled

• view_props

  The filters and display properties the user selected for viewing the issues in the module

• sort_order

  The position at which the module is displayed

• created_by , updated_by uuid

  IDs of the users who created and last updated the module. Plane sets these automatically.

• Project uuid

  The project's UUID. Plane sets it automatically.

• Workspace uuid

  The workspace's UUID. Plane sets it automatically.

• lead uuid

  Lead of the module

• members string[]

  List of member user IDs assigned to the module

• archived_at timestamp

  When the module was archived, if it is archived

• logo_props

  Logo properties for the module

• description_text

  Description in plain text format

Response200

{
  "id": "b69b19ae-261f-428c-899f-dd58efaa36c0",
  "created_at": "2023-11-19T11:48:21.130161Z",
  "updated_at": "2023-11-19T11:48:21.130168Z",
  "name": "module stesting",
  "description": "",
  "description_text": null,
  "description_html": null,
  "start_date": null,
  "target_date": null,
  "status": "planned",
  "view_props": {},
  "sort_order": 55535.0,
  "created_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c",
  "updated_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c",
  "project": "6436c4ae-fba7-45dc-ad4a-5440e17cb1b2",
  "workspace": "c467e125-59e3-44ec-b5ee-f9c1e138c611",
  "lead": null,
  "members": []
}