Skip to content

list-links.md

Latest commit

 

History

History
115 lines (80 loc) · 2.42 KB

list-links.md

File metadata and controls

115 lines (80 loc) · 2.42 KB
title List all links
description List all links via Plane API. HTTP GET request with pagination, filtering, and query parameters.
keywords plane api, list links, get all links, work item links, issue links, rest api, api integration

List all links

GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/

Returns a list of all links attached to a work item.

Path Parameters

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

The unique identifier of the project.

The unique identifier for the work item.

Scopes

projects.work_items.links:read

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())
const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your-api-key"
    }
  }
);
const data = await response.json();
{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}