List project release links

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

Return the links on a project release as a paginated list, newest first by default.

You need view access to the release. Without it, the request returns 404, the same answer as for a release that doesn't exist in the project.

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 the release belongs to. Accepts the project UUID or its bare identifier, for example ENG.

release_id:requiredstring (uuid)

The release whose links you want.

Query Parameters

search:optionalstring

A search term matched against each link's title and url.

Ordering

order_by:optionalstring

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

• created_at, -created_at
• 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. Read the next value from the response rather than computing offsets yourself.

paginate:optionalstring

Set to cursor to opt into the COUNT-free keyset envelope, which returns next_cursor and has_more instead of next and total_count. Omit it for the default offset envelope.

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. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

Requestable here: created_at, created_by_id, id, metadata, release_id, title, updated_at, updated_by_id, url.

See Sparse fields.

Scopes

releases.links:read

Errors

Status	Code	Cause
400	invalid_request	offset or a ?fields= name failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project releases aren't enabled on your plan.
403	forbidden	Your token scope doesn't allow this.
404	not_found	No release with this id in this project, you can't view the release, or no such workspace or project.
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 release links

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/" \
  -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/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39",
      "release_id": "3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14",
      "title": "GitHub release v4.2.0",
      "url": "https://github.com/acme/mobile/releases/tag/v4.2.0",
      "metadata": {},
      "created_at": "2026-02-26T18:10:44.209631Z",
      "updated_at": "2026-02-26T18:10:44.209631Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 1,
  "pagination": {
    "style": "offset"
  }
}