Plane DocsSign in

Overview ​

Cycles are custom time periods in which a team works to complete items from their backlog. At the end of a cycle, the team typically has a new version of their project or product ready.

Learn more about cycles

The cycle object ​

Attributes ​

  • name string (required)

    Name of the cycle.

  • description string

    Description of the cycle.

  • start_date date

    Start date of the cycle.

  • end_date date

    End date of the cycle.

  • created_at timestamp

    When the cycle was created.

  • updated_at timestamp

    When the cycle was last updated.

  • view_props

    The filters and display properties the user selected for viewing the cycle's work items.

  • sort_order

    Position used for manual ordering.

  • created_by , updated_by uuid

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

  • Project uuid

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

  • Workspace uuid

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

  • owned_by uuid

    ID of the user who owns the cycle.

  • archived_at timestamp

    When the cycle was archived, if it has been.

  • timezone string

    The cycle's timezone.

  • version number

    Version number of the cycle.

Response200
json
{
  "id": "50ebc791-65e4-4b4d-a164-3b4e529e55a5",
  "created_at": "2023-11-19T12:18:14.900078Z",
  "updated_at": "2023-11-19T12:18:14.900088Z",
  "name": "cycle testing",
  "description": "",
  "start_date": null,
  "end_date": null,
  "view_props": {},
  "sort_order": 35535.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",
  "owned_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c"
}