Get a role

GET/api/v2/workspaces/{slug}/roles/{pk}/

Roles are the named permission levels a member can hold. Read a single role by id.

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

The role id.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: based_on_id, description, id, is_system, level, name, namespace, permission_scheme_ids, permissions, slug, status, updated_at.

expand:optionalstring

Comma-separated relations to embed alongside the ids: permission_schemes (the permission schemes attached to the role, each with id, name, slug, namespace, and is_system).

Expansion is separate-key. ?expand=permission_schemes keeps permission_scheme_ids and adds a permission_schemes array next to it. An unknown value is a 400. See Expanding relations.

Scopes

workspaces.roles: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 role

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

import requests

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

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

Response200

{
  "id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
  "name": "QA Reviewer",
  "slug": "qa-reviewer",
  "description": "Commenter access plus editing work items.",
  "namespace": "project",
  "is_system": false,
  "level": 10,
  "status": "active",
  "based_on_id": "6e2a9d47-1c5b-4f83-a7d0-3b8e4f1c9a62",
  "permission_scheme_ids": ["f3b8a1c6-2d7e-4a95-8c14-5e9d0b3f7a28"],
  "permissions": [
    "comment:create",
    "comment:edit+creator",
    "cycle:view",
    "module:view",
    "project:view",
    "state:view",
    "workitem:edit",
    "workitem:view"
  ],
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "permission_schemes": [
    {
      "id": "f3b8a1c6-2d7e-4a95-8c14-5e9d0b3f7a28",
      "name": "QA review",
      "slug": "qa-review",
      "namespace": "project",
      "is_system": false
    }
  ]
}

Response404

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