List roles

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

Roles are the named permission levels a member can hold. List the roles you can see. Results are scoped to the path and to what your token is allowed to read.

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.

Query Parameters

count:optionalboolean

Set to false to skip the total_count COUNT(*) (omits total_count).

is_system:optionalboolean

Filter by is_system.

namespace:optionalstring

Whether this role is for instance, workspace, or project-level resources

• instance - Instance
• workspace - Workspace
• project - Project

One of instance, project, workspace.

offset:optionalinteger

Number of rows to skip from the start of the result set.

order_by:optionalstring

Field to order the list by. Prefix with '-' for descending (e.g. '-created_at'). Annotation-backed orders sort semantically and ride the default offset page.

paginate:optionalstring

Set to 'cursor' to opt into the COUNT-free keyset cursor envelope (use for deep traversal); omit for the default offset envelope with total_count.

One of cursor.

per_page:optionalinteger

Page size (max 200).

search:optionalstring

A search term.

slug:optionalstring

Filter by slug.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from each row, not returned as null. id always comes back. Pass all for every requestable field.

An unknown name is a 400 that names the valid set, so a typo can't silently cost you the saving. 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.

List roles

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/roles/?is_system=false&namespace=project" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

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

const params = new URLSearchParams({ is_system: "false", namespace: "project" });
const response = await fetch(`https://api.plane.so/api/v2/workspaces/my-team/roles/?${params}`, {
  method: "GET",
  headers: {
    "X-Api-Key": "your-api-key",
  },
});
const data = await response.json();

Response200

{
  "data": [
    {
      "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"
    },
    {
      "id": "3d8f5a62-7b1e-4c94-a0d3-9e6c2f8b1a57",
      "name": "Release Manager",
      "slug": "release-manager",
      "description": "Plans cycles and reads work items.",
      "namespace": "project",
      "is_system": false,
      "level": 15,
      "status": "active",
      "based_on_id": null,
      "permission_scheme_ids": [
        "b51d7e09-8a3c-4f62-9e17-4c2a6d8f1b95",
        "7a4c9e12-5f3b-4d68-8e01-2b6d9f4a3c85"
      ],
      "permissions": [
        "cycle:create",
        "cycle:edit",
        "cycle:manage_issues",
        "cycle:view",
        "project:view",
        "workitem:view"
      ],
      "updated_at": "2026-01-13T16:04:02.911204Z"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}