Releases overview

Releases group shipped work and carry a changelog.

The release object

Attributes

• created_at string (date-time)

  When the record was created.

• created_by_id string (uuid)

  The user who created the record.

• description_html string

  Rich-text body as HTML. This is the field the Plane editor round-trips.

• description_id string (uuid)

  The related description.

• external_id string

  Your system's identifier for this record, for sync and import correlation.

• external_source string

  The system external_id came from, for example github or jira.

• id string (uuid)

  Unique identifier.

• is_latest boolean

  Whether is latest.

• is_prerelease boolean

  Whether is prerelease.

• label_ids array of string

  Ids of the associated labels.

• lead_id string (uuid)

  The related lead.

• name string

  Display name.

• release_date string (date)

  The release date.

• status string

  The status.

• tag_id string (uuid)

  The related tag.

• target_date string (date)

  Planned due date, as YYYY-MM-DD.

Response200

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description_html": "<p>Details go here.</p>",
  "description_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_latest": false,
  "is_prerelease": false,
  "label_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  "lead_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "name": "Example name",
  "release_date": "2026-01-20",
  "status": "unreleased",
  "tag_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "target_date": "2026-01-20"
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/releases/	List releases
GET	/api/v2/workspaces/{slug}/releases/{pk}/changelog/	Get a release changelog
GET	/api/v2/workspaces/{slug}/releases/{pk}/	Get a release
POST	/api/v2/workspaces/{slug}/releases/	Create a release
PATCH	/api/v2/workspaces/{slug}/releases/{pk}/changelog/	Update a release changelog
PATCH	/api/v2/workspaces/{slug}/releases/{pk}/	Update a release
DELETE	/api/v2/workspaces/{slug}/releases/{pk}/	Delete a release
POST	/api/v2/workspaces/{slug}/releases/{pk}/labels/	Add or remove release labels
POST	/api/v2/workspaces/{slug}/releases/{pk}/work-items/	Add or remove release work items

Response shaping

Every release read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.