feat(api): add lite list endpoints for projects, members, cycles, and modules (#9410)

* feat: add lite list endpoints for projects, members, cycles, and modules

* refactor: enhance order_by sanitization for cycle and module endpoints, update error handling for non-existent projects and workspaces

Author: akhil-vamshi-konam

apps/api/plane/api/serializers/__init__.py

@@ -62,5 +62,9 @@
     FileAssetSerializer,
 )
 from .invite import WorkspaceInviteSerializer
-from .member import ProjectMemberSerializer
+from .member import (
+    ProjectMemberSerializer,
+    WorkspaceMemberLiteAPISerializer,
+    ProjectMemberLiteAPISerializer,
+)
 from .sticky import StickySerializer

apps/api/plane/api/serializers/member.py

@@ -41,3 +41,45 @@ class Meta:
         model = ProjectMember
         fields = ["id", "member", "role"]
         read_only_fields = ["id"]
+
+
+class BaseMemberLiteAPISerializer(BaseSerializer):
+    """Common flattened member representation for paginated member pickers/directories."""
+
+    id = serializers.UUIDField(source="member.id", read_only=True)
+    first_name = serializers.CharField(source="member.first_name", read_only=True)
+    last_name = serializers.CharField(source="member.last_name", read_only=True)
+    email = serializers.EmailField(source="member.email", read_only=True)
+    avatar = serializers.CharField(source="member.avatar", read_only=True, allow_null=True)
+    avatar_url = serializers.CharField(source="member.avatar_url", read_only=True, allow_null=True)
+    display_name = serializers.CharField(source="member.display_name", read_only=True)
+    is_bot = serializers.BooleanField(source="member.is_bot", read_only=True)
+
+    class Meta:
+        fields = [
+            "id",
+            "first_name",
+            "last_name",
+            "email",
+            "avatar",
+            "avatar_url",
+            "display_name",
+            "role",
+            "is_active",
+            "is_bot",
+        ]
+        read_only_fields = fields
+
+
+class WorkspaceMemberLiteAPISerializer(BaseMemberLiteAPISerializer):
+    """Minimal WorkspaceMember representation for paginated member pickers/directories."""
+
+    class Meta(BaseMemberLiteAPISerializer.Meta):
+        model = WorkspaceMember
+
+
+class ProjectMemberLiteAPISerializer(BaseMemberLiteAPISerializer):
+    """Minimal ProjectMember representation for paginated member pickers/directories."""
+
+    class Meta(BaseMemberLiteAPISerializer.Meta):
+        model = ProjectMember

apps/api/plane/api/serializers/project.py

@@ -318,5 +318,6 @@ class Meta:
             "emoji",
             "description",
             "cover_image_url",
+            "archived_at",
         ]
         read_only_fields = fields

apps/api/plane/api/urls/cycle.py

@@ -6,6 +6,7 @@
 
 from plane.api.views.cycle import (
     CycleListCreateAPIEndpoint,
+    CycleListLiteAPIEndpoint,
     CycleDetailAPIEndpoint,
     CycleIssueListCreateAPIEndpoint,
     CycleIssueDetailAPIEndpoint,
@@ -19,6 +20,11 @@
         CycleListCreateAPIEndpoint.as_view(http_method_names=["get", "post"]),
         name="cycles",
     ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/cycles-lite/",
+        CycleListLiteAPIEndpoint.as_view(http_method_names=["get"]),
+        name="cycles-lite",
+    ),
     path(
         "workspaces/<str:slug>/projects/<uuid:project_id>/cycles/<uuid:pk>/",
         CycleDetailAPIEndpoint.as_view(http_method_names=["get", "patch", "delete"]),

apps/api/plane/api/urls/member.py

@@ -7,7 +7,9 @@
 from plane.api.views import (
     ProjectMemberListCreateAPIEndpoint,
     ProjectMemberDetailAPIEndpoint,
+    ProjectMemberLiteAPIEndpoint,
     WorkspaceMemberAPIEndpoint,
+    WorkspaceMemberLiteAPIEndpoint,
 )
 
 urlpatterns = [
@@ -27,6 +29,11 @@
         ProjectMemberListCreateAPIEndpoint.as_view(http_method_names=["get", "post"]),
         name="project-members",
     ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/project-members-lite/",
+        ProjectMemberLiteAPIEndpoint.as_view(http_method_names=["get"]),
+        name="project-members-lite",
+    ),
     path(
         "workspaces/<str:slug>/projects/<uuid:project_id>/project-members/<uuid:pk>/",
         ProjectMemberDetailAPIEndpoint.as_view(http_method_names=["patch", "delete", "get"]),
@@ -37,4 +44,9 @@
         WorkspaceMemberAPIEndpoint.as_view(http_method_names=["get"]),
         name="workspace-members",
     ),
+    path(
+        "workspaces/<str:slug>/members-lite/",
+        WorkspaceMemberLiteAPIEndpoint.as_view(http_method_names=["get"]),
+        name="workspace-members-lite",
+    ),
 ]

apps/api/plane/api/urls/module.py

@@ -6,6 +6,7 @@
 
 from plane.api.views import (
     ModuleListCreateAPIEndpoint,
+    ModuleListLiteAPIEndpoint,
     ModuleDetailAPIEndpoint,
     ModuleIssueListCreateAPIEndpoint,
     ModuleIssueDetailAPIEndpoint,
@@ -18,6 +19,11 @@
         ModuleListCreateAPIEndpoint.as_view(http_method_names=["get", "post"]),
         name="modules",
     ),
+    path(
+        "workspaces/<str:slug>/projects/<uuid:project_id>/modules-lite/",
+        ModuleListLiteAPIEndpoint.as_view(http_method_names=["get"]),
+        name="modules-lite",
+    ),
     path(
         "workspaces/<str:slug>/projects/<uuid:project_id>/modules/<uuid:pk>/",
         ModuleDetailAPIEndpoint.as_view(http_method_names=["get", "patch", "delete"]),

apps/api/plane/api/urls/project.py

@@ -6,6 +6,7 @@
 
 from plane.api.views import (
     ProjectListCreateAPIEndpoint,
+    ProjectListLiteAPIEndpoint,
     ProjectDetailAPIEndpoint,
     ProjectArchiveUnarchiveAPIEndpoint,
     ProjectSummaryAPIEndpoint,
@@ -17,6 +18,11 @@
         ProjectListCreateAPIEndpoint.as_view(http_method_names=["get", "post"]),
         name="project",
     ),
+    path(
+        "workspaces/<str:slug>/projects-lite/",
+        ProjectListLiteAPIEndpoint.as_view(http_method_names=["get"]),
+        name="project-lite",
+    ),
     path(
         "workspaces/<str:slug>/projects/<uuid:pk>/",
         ProjectDetailAPIEndpoint.as_view(http_method_names=["get", "patch", "delete"]),

apps/api/plane/api/views/__init__.py

@@ -4,6 +4,7 @@
 
 from .project import (
     ProjectListCreateAPIEndpoint,
+    ProjectListLiteAPIEndpoint,
     ProjectDetailAPIEndpoint,
     ProjectArchiveUnarchiveAPIEndpoint,
     ProjectSummaryAPIEndpoint,
@@ -34,6 +35,7 @@
 
 from .cycle import (
     CycleListCreateAPIEndpoint,
+    CycleListLiteAPIEndpoint,
     CycleDetailAPIEndpoint,
     CycleIssueListCreateAPIEndpoint,
     CycleIssueDetailAPIEndpoint,
@@ -43,13 +45,20 @@
 
 from .module import (
     ModuleListCreateAPIEndpoint,
+    ModuleListLiteAPIEndpoint,
     ModuleDetailAPIEndpoint,
     ModuleIssueListCreateAPIEndpoint,
     ModuleIssueDetailAPIEndpoint,
     ModuleArchiveUnarchiveAPIEndpoint,
 )
 
-from .member import ProjectMemberListCreateAPIEndpoint, ProjectMemberDetailAPIEndpoint, WorkspaceMemberAPIEndpoint
+from .member import (
+    ProjectMemberListCreateAPIEndpoint,
+    ProjectMemberDetailAPIEndpoint,
+    ProjectMemberLiteAPIEndpoint,
+    WorkspaceMemberAPIEndpoint,
+    WorkspaceMemberLiteAPIEndpoint,
+)
 
 from .intake import (
     IntakeIssueListCreateAPIEndpoint,

apps/api/plane/api/views/cycle.py

@@ -27,6 +27,7 @@
 from plane.api.serializers import (
     CycleIssueSerializer,
     CycleSerializer,
+    CycleLiteSerializer,
     CycleIssueRequestSerializer,
     TransferCycleIssueRequestSerializer,
     CycleCreateSerializer,
@@ -46,7 +47,7 @@
     UserFavorite,
 )
 from plane.utils.cycle_transfer_issues import transfer_cycle_issues
-from plane.utils.order_queryset import ISSUE_ORDER_BY_ALLOWLIST, sanitize_order_by
+from plane.utils.order_queryset import CYCLE_ORDER_BY_ALLOWLIST, ISSUE_ORDER_BY_ALLOWLIST, sanitize_order_by
 from plane.utils.host import base_host
 from .base import BaseAPIView
 from plane.bgtasks.webhook_task import model_activity
@@ -356,6 +357,54 @@ def post(self, request, slug, project_id):
             )
 
 
+class CycleListLiteAPIEndpoint(BaseAPIView):
+    """Cycle Lite List Endpoint"""
+
+    serializer_class = CycleLiteSerializer
+    model = Cycle
+    permission_classes = [ProjectEntityPermission]
+    use_read_replica = True
+
+    @cycle_docs(
+        operation_id="list_cycles_lite",
+        summary="List cycles (lite)",
+        description="Retrieve a paginated, lightweight list of cycles in a project for pickers and references.",
+        parameters=[CURSOR_PARAMETER, PER_PAGE_PARAMETER, ORDER_BY_PARAMETER],
+        responses={
+            200: create_paginated_response(
+                CycleLiteSerializer,
+                "PaginatedCycleLiteResponse",
+                "Paginated list of cycles with minimal fields",
+                "Paginated Cycles (Lite)",
+            ),
+        },
+    )
+    def get(self, request, slug, project_id):
+        """List cycles (lite)
+
+        Retrieve a paginated, lightweight list of non-archived cycles in a project,
+        optimized for pickers and references.
+        """
+        cycles = (
+            Cycle.objects.filter(workspace__slug=slug, project_id=project_id)
+            .filter(archived_at__isnull=True)
+            .select_related("project", "workspace", "owned_by")
+            .order_by(
+                sanitize_order_by(
+                    request.GET.get("order_by", "-created_at"),
+                    CYCLE_ORDER_BY_ALLOWLIST,
+                    default="-created_at",
+                )
+            )
+            .distinct()
+        )
+        return self.paginate(
+            request=request,
+            queryset=cycles,
+            on_results=lambda cycles: CycleLiteSerializer(cycles, many=True).data,
+        )
+
+
 class CycleDetailAPIEndpoint(BaseAPIView):
     """
     This viewset automatically provides `retrieve`, `update` and `destroy` actions related to cycle.

apps/api/plane/api/views/issue.py

@@ -314,6 +314,20 @@ def get(self, request, slug, project_id):
         Supports filtering, ordering, and field selection through query parameters.
         """
 
+        unsupported_filters = [param for param in ("pql", "filters") if request.GET.get(param)]
+        if unsupported_filters:
+            return Response(
+                {
+                    "pql": (
+                        "PQL and structured filters are not supported on this Plane edition. "
+                        "Remove the pql/filters parameter and filter results client-side, or use "
+                        "a Plane edition that supports work item query filtering."
+                    ),
+                    "unsupported_parameters": unsupported_filters,
+                },
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
         external_id = request.GET.get("external_id")
         external_source = request.GET.get("external_source")