Get subscribers by identifier

GET/api/v2/workspaces/{slug}/work-items/{identifier}/subscribers/

Get the users subscribed to a work item, addressed by its key (PROJ-142) or its UUID. You don't need the project UUID.

This returns the same list as Get subscribers: active project members and, while teamspaces are on for the workspace, linked teamspace members, oldest subscription first. Bots are never listed. It works on archived work items too.

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.

identifier:requiredstring

The work item's key, such as PROJ-142, or its UUID.

The project part of the key is upper-cased before lookup, so proj-142 finds the same work item as PROJ-142.

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	Malformed identifier, no such work item, it's in another workspace, 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 by identifier

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/work-items/PROJ-142/subscribers/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/work-items/PROJ-142/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/work-items/PROJ-142/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."
}

To change the list with the same key, see Update subscribers by identifier.