Get subscribers

GET/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{pk}/subscribers/

Get the users subscribed to a work item, oldest subscription first.

The list only includes users who can currently subscribe: active project members and, while teamspaces are on for the workspace, members of a teamspace linked to the project. Bots and anyone who subscribed and later left the project are not listed. An empty subscriber_ids array means nobody is subscribed.

This works on archived work items without ?archived=.

If you only have a key like PROJ-142, use Get subscribers by identifier instead.

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 (uuid)

The project the work item belongs to.

pk:requiredstring (uuid)

The work item's UUID. A PROJ-142 identifier here returns 404.

Scopes

projects.work_items:read

Errors

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403	forbidden	Your token scope can't read work items.
404	not_found	No such work item, it's outside your project or tenant, you can't view it, or it's a draft, a triage work item, or in an archived project.
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 subscribers

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/subscribers/" \
  -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"
    "/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/subscribers/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json()["subscriber_ids"])

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b" +
    "/work-items/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/subscribers/",
  {
    method: "GET",
    headers: { "X-Api-Key": "your-api-key" },
  },
);
const data = await response.json();

Response200

{
  "subscriber_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430", "a3d9e0c4-7b21-4f58-9e6d-2c84b1f07a95"]
}

Response404

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

The ids are user ids, the same values as member_id on member rows. To get names and emails, call List workspace members with ?member_id__in= and ?expand=member. Use the workspace roster rather than the project roster, because subscribers who come from a linked teamspace aren't project members.

To change the list, see Update subscribers.