Work item links overview

Links attach external URLs to a work item.

The link object

Attributes

• created_at string (date-time)

  When the link was created.

• updated_at string (date-time)

  When the link was last updated.

• created_by_id string (uuid)

  The user who created the link.

• updated_by_id string (uuid) or null

  The user who last updated the link. null until someone updates it.

• id string (uuid)

  Unique identifier for the link.

• metadata string

  Metadata stored with the link.

• title string

  The link's display title.

• url string

  Target URL.

• work_item_id string (uuid)

  The work item the link is attached to.

Response200

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "metadata": null,
  "title": "Example title",
  "url": "https://example.com/spec",
  "work_item_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/links/	List links
GET	/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/links/{pk}/	Get a link
POST	/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/links/	Create a link
PATCH	/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/links/{pk}/	Update a link
DELETE	/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/links/{pk}/	Delete a link

Response shaping

Every link read accepts ?fields= for sparse responses. See Sparse fields. Errors follow the shared problem+json contract.