Get a sticky
GET/api/v2/workspaces/{slug}/stickies/{pk}/
Stickies are private notes owned by the calling user. Read a single sticky by id.
Path parameters
slug:requiredstringThe workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.
pk:requiredstring (uuid)The sticky id.
Response shaping
fields:optionalstringComma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null. id is always included. Pass all to get every requestable field. An unknown field name returns 400. See Sparse fields.
Requestable here: background_color, color, created_at, created_by_id, description_html, description_stripped, id, logo_props, name, owner_id, sort_order, updated_at, updated_by_id.
Scopes
stickies: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 role or token scope doesn't allow this. |
404 | not_found | No such resource, or it's outside your tenant. |
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 a sticky
bash
curl -X GET \
"https://api.plane.so/api/v2/workspaces/my-team/stickies/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
-H "X-Api-Key: $PLANE_API_KEY"python
import requests
response = requests.get(
"https://api.plane.so/api/v2/workspaces/my-team/stickies/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
headers={"X-Api-Key": "your-api-key"},
)
print(response.json())javascript
const response = await fetch(
"https://api.plane.so/api/v2/workspaces/my-team/stickies/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
{
method: "GET",
headers: {
"X-Api-Key": "your-api-key",
},
},
);
const data = await response.json();Response200
json
{
"background_color": "example",
"color": "#3f76ff",
"created_at": "2026-01-14T09:22:41.478363Z",
"updated_at": "2026-01-14T09:22:41.478363Z",
"created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
"updated_by_id": null,
"description_html": "<p>Details go here.</p>",
"description_stripped": "example",
"id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
"logo_props": null,
"name": "Example name",
"owner_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
"sort_order": 65535
}Response404
json
{
"type": "not_found",
"code": "not_found",
"detail": "No sticky matches the given query."
}
