A specific version or deployment of product features to customers. Releases help teams plan what to deliver and when.
What is a Release?
A Release is a planned delivery of features to customers. It represents a version, sprint, or deployment milestone — the answer to "What ships and when?"
Releases exist independently of the product hierarchy. Features from different products and components can be assigned to the same release, making releases a cross-cutting way to plan delivery timelines.
When to use it
- Release planning automation — Create releases programmatically to match your sprint cadence, version scheme, or deployment schedule.
- Delivery tracking — Query features assigned to a release to monitor what's on track, at risk, or overdue.
- Changelog generation — Pull the list of features in a release to auto-generate release notes or changelogs.
- Cross-tool synchronization — Sync releases with project management tools to keep delivery timelines consistent.
Key fields
| Field | Description |
|---|---|
name | Display name of the release (e.g., "v2.4", "Q2 Sprint 3") |
description | Rich-text description with release goals or scope |
status | Current status |
owner | The member responsible for this release |
timeframe | Planned delivery window with start/end dates |
archived | Whether the release has been archived |
Field availability depends on your workspace configuration. Use the Configuration endpoint to discover which fields are available for the release type in your workspace.
Relationships
| Relationship | Description |
|---|---|
parent | The release group this release belongs to (if any) |
link | Features assigned to this release |
Related objects
- Release Group — a container for related releases
- Feature — features assigned to this release
- Subfeature — subfeatures assigned to this release
