Get a project release link

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

Retrieve one link on a project release by id.

Reading a link needs view access to its release. If you can't view the release, the request returns 404, not 403, so the response doesn't reveal whether the release or the link exists. A link id that belongs to a different release, or a release outside the project in the path, also returns 404.

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 the link is on.

pk:requiredstring (uuid)

The id of the link to retrieve.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. 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 to get every requestable field. 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, 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	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 such link on this release, no such release in this project, or you can't view the release.
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.

Get a project release link

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/6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39/" \
  -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/6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39/",
    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/6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "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": null
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}