Get project role distribution

GET/api/v2/workspaces/{slug}/project-role-distribution/

Members are the people on a workspace or project, and the role each one holds.

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.

Scopes

workspaces.members: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 project role distribution

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/project-role-distribution/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/project-role-distribution/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/project-role-distribution/",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "roles": [
    {
      "distinct_member_count": 3,
      "is_system": false,
      "level": 1,
      "membership_count": 3,
      "name": "Example name",
      "role_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "slug": "my-team"
    }
  ],
  "total_distinct_members": 3,
  "total_memberships": 3
}