List a work item's links

GEThttps://<your-url>/api/v2/work-items/{work_item}/links

MCP id work-items.links.indexAlso on this path: POST Link a work item to another

Returns every link touching one work item, in both directions: the links it is the source of and the links it is the target of, which is what the linked items section in plnnrly shows.

Token scope: api:read:project_management
Without it: 403 insufficient-token-scope.
Permission: project_management::view_backlog
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: each include +1.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: Everything blocking, or blocked by, one work item

curl -G \
  'https://<your-url>/api/v2/work-items/1/links' \
  --data-urlencode 'filter[link_type]=blocks' \
  --data-urlencode 'include=source_work_item,target_work_item' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/work-items/1/links?filter[link_type]=blocks&include=source_work_item%2Ctarget_work_item', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/work-items/1/links?filter[link_type]=blocks&include=source_work_item%2Ctarget_work_item');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/work-items/1/links?filter[link_type]=blocks&include=source_work_item%2Ctarget_work_item',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "source_work_item_id": 1,
      "target_work_item_id": 1,
      "link_type": "blocks",
      "created_by": 1,
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "direction": "…",
      "relationship": "…",
      "source_work_item": {
        "id": 1
      },
      "target_work_item": {
        "id": 1
      },
      "links": {
        "…": "1 field of WorkItemLinkLinks"
      }
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

direction and relationship on each row are relative to the work item in the path, so the same link reads forward / blocks here and inverse / is blocked by from the other end. The path accepts a numeric id or an issue key, so work-items/ACM-123/links works. There is no organisation-wide collection of links and no filter[source_work_item_id] or filter[target_work_item_id]: the path supplies both. Ordered by id ascending, and meta.page.total is always present; ?with_total is a 400. Listing additionally requires project_management::manage_work_items on the work item.

Path parameters

work_iteminteger or stringRequired

The WorkItem's numeric id. Or its issue_key, matching [A-Z][A-Z0-9]*-[0-9]+.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

18 parameters in 5 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request.

Filters

=: equals
[in]: any of a comma-separated list
[null]: true or false: whether it is empty
[gte][lt]: at least, less than
[ne]: not equal

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[created_by]integer=[in][null]

User who created the link. [null] selects links whose creator has since been deleted.

A comma-separated list of at most 100 values.

filter[link_type]string=[ne][in]

Relationship type: blocks, clones, duplicates, merged_into, causes, relates_to or split_to. The value is stored from the source item's point of view, so it does not flip on an inverse link: filter on blocks and you get both the items this one blocks and the items that block it.

A comma-separated list of at most 100 values.

blocks
clones
duplicates
merged_into
causes
relates_to
split_to

New values may be added.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: id

Key	Sorts by
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`source_work_item`	Work item the link points away from, with its issue key and title.	+1
`target_work_item`	Work item the link points at, with its issue key and title.	+1

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a page of WorkItemLinkList rows.

dataarray of WorkItemLinkList

The rows, each a WorkItemLinkList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a WorkItemLinkList: 12 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning