Get a project summary

GET/api/v2/workspaces/{slug}/projects/{pk}/summary/

Projects are the main container for work items in a workspace.

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.

pk:requiredstring

The project summary id.

Query Parameters

counts:optionalstring

Comma-separated count keys to include. Allowed: members, states, labels, cycles, modules, issues, intakes, work_item_types, work_item_properties, pages. Omitting returns all. Unknown keys are a 400.

Scopes

projects: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 project summary

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/summary/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/summary/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/summary/",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "counts": {},
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "identifier": "PROJ",
  "name": "Example name"
}