ProjectLink

A named external URL pinned to a project, such as a staging environment, a design file or a repository.

Summary view: ProjectLinkList, 8 fields. What a list returns by default.
Detail view: ProjectLink, 8 fields. The default for a single read and for every write.
Read with: api:read:projectsandprojects::links
Write with: api:write:projectsandprojects::links

Example

detail view

{
  "id": 1,
  "project_id": 1,
  "project": {
    "id": 1
  },
  "name": "Staging",
  "url": "https://staging.example.test",
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1"
  }
}

Deleting one is permanent, and every write bumps the owning project's updated_at and lands in the project's activity timeline.

Used by

GETList project links/project-linksProjectLinkList

POSTCreate a project link/project-linksProjectLink

GETRead a project link/project-links/{project_link}ProjectLink

PATCHUpdate a project link/project-links/{project_link}ProjectLink

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

idinteger

Unique identifier.

project_idinteger

Owning project.

projectRef or ProjectSummary

The project this link belongs to.

namestring≤ 255

Link name as shown in the UI, e.g. Staging. This is the default sort key.

urlstringMultiline

The link target, e.g. https://staging.example.test.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

linksProjectLinkLinks

Show 1 child field

links.selfurl

The canonical URI of this record.

Variants

ProjectLinkList 8 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

ProjectLinkSummary 3 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: project_id, project, created_at, updated_at, links

ProjectLinkLinks 1 field

The links object on this resource.

Keys: self

Something wrong or missing on this page? Tell us