List project releases

GET/api/v2/workspaces/{slug}/projects/{project_id}/releases/

Return the releases in one project as a paginated list, newest first by default.

Only this project's releases come back. Workspace releases and releases in other projects never appear here. To read workspace releases, use List releases.

List rows leave out description_html. Name it in ?fields= when you need the description on every row, or read one release with Get a project release.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring

The project whose releases you want to list. Accepts the project UUID or its bare identifier, for example ENG.

Query parameters

Filters combine with AND. A malformed filter value, such as a status outside the enum or a lead_id that isn't a UUID, returns 400 invalid_request.

status:optionalstring

Return only releases in this status. One of unreleased, released, or cancelled.

Use status__in to match several statuses at once, comma-separated, for example ?status__in=unreleased,released.

name:optionalstring

Return releases whose name matches this value exactly, ignoring case.

lead_id:optionalstring (uuid)

Return releases led by this user.

tag_id:optionalstring (uuid)

Return releases that carry this release tag.

is_latest:optionalboolean

Return only releases marked as latest (true) or only the others (false).

is_prerelease:optionalboolean

Return only pre-releases (true) or only the others (false).

target_date:optionalstring (date)

Return releases with this planned ship date, as YYYY-MM-DD.

release_date:optionalstring (date)

Return releases that shipped on this date, as YYYY-MM-DD.

search:optionalstring

A search term matched against the release name.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to -created_at.

• created_at, -created_at
• target_date, -target_date
• release_date, -release_date
• name, -name
• id, -id

An unrecognized value falls back to the default ordering without an error.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Use the next value from the response instead of computing offsets yourself.

paginate:optionalstring

Set to cursor to switch to the keyset envelope, which skips the COUNT query and returns next_cursor and has_more instead of next and total_count. Leave it out to get the default offset envelope.

The cursor works only with the created_at and id orderings. Pairing it with name, target_date, or release_date returns 400 ordering_not_cursor_eligible.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then left out of the response.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all for every requestable field, including description_html. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: created_at, created_by_id, description_html, description_id, external_id, external_source, id, is_latest, is_prerelease, label_ids, lead_id, name, project_id, release_date, status, tag_id, target_date, updated_at, updated_by_id.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: lead (the lead user) and tag (the release tag).

Expanded objects get their own key: ?expand=lead keeps lead_id and adds a lead object next to it, so an id is never replaced by an object. An unknown value returns 400. See Expanding relations.

Scopes

releases:read

Errors

Status	Code	Cause
400	invalid_request	A filter value, offset, or ?fields= name failed validation.
400	ordering_not_cursor_eligible	paginate=cursor with an ordering other than created_at or id.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project releases aren't enabled on your plan.
403	forbidden	You can't view releases in this project, no project with this id exists, or your token scope doesn't allow this.
404	not_found	No such workspace.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List project releases

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/?status__in=unreleased,released&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/",
    headers={"X-Api-Key": "your-api-key"},
    params={"status__in": "unreleased,released", "per_page": 50},
)
print(response.json())

const params = new URLSearchParams({ status__in: "unreleased,released", per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14",
      "name": "Mobile 4.2.0",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "description_id": "5d2b7e91-4a3c-4f68-9e0d-1c7a8b2f6e35",
      "status": "unreleased",
      "target_date": "2026-02-27",
      "release_date": null,
      "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "tag_id": "a41c9e07-2f5d-4b83-8c6e-9d1f0a3b7c52",
      "is_latest": false,
      "is_prerelease": false,
      "external_id": null,
      "external_source": null,
      "label_ids": ["7f3a2c19-8e4d-4b61-a5c7-2d9e0f1b8a46"],
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    },
    {
      "id": "b2d94f6a-1e3c-4a87-9f05-6c8e2a1d7b39",
      "name": "Mobile 4.1.0",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "description_id": "c7e30a58-6f1d-4b92-8a4c-3e9d2b7f0a16",
      "status": "released",
      "target_date": "2026-01-09",
      "release_date": "2026-01-09",
      "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "tag_id": null,
      "is_latest": true,
      "is_prerelease": false,
      "external_id": null,
      "external_source": null,
      "label_ids": [],
      "created_at": "2025-12-02T14:05:17.220514Z",
      "updated_at": "2026-01-09T17:41:03.915820Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "id": "3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14",
      "name": "Mobile 4.2.0",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "description_id": "5d2b7e91-4a3c-4f68-9e0d-1c7a8b2f6e35",
      "status": "unreleased",
      "target_date": "2026-02-27",
      "release_date": null,
      "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "tag_id": "a41c9e07-2f5d-4b83-8c6e-9d1f0a3b7c52",
      "is_latest": false,
      "is_prerelease": false,
      "external_id": null,
      "external_source": null,
      "label_ids": ["7f3a2c19-8e4d-4b61-a5c7-2d9e0f1b8a46"],
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next_cursor": "b3A9MTcx",
  "has_more": true,
  "pagination": {
    "style": "cursor"
  }
}