Merge pull request #89 from makeplane/members-api

Members API endpoint

Author: danciaclara

api-reference/members/get-project-members.mdx

@@ -0,0 +1,48 @@
+---
+title: Get project members
+sidebarTitle: Project members
+description: Retrieve the list of all members in a project.
+api: GET /api/v1/workspaces/:workspace-slug/projects/:project_id/members/
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required>
+The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
+
+</ParamField>
+<ParamField path="project_id" type="string" required>The unique identifier of the project</ParamField>
+
+### Response
+
+```json
+[
+    {
+        "id": "00000000-0000-0000-0000-000000000001",
+        "first_name": "User",
+        "last_name": "One",
+        "email": "[email protected]",
+        "avatar": "",
+        "avatar_url": null,
+        "display_name": "user1",
+    },
+    {
+        "id": "00000000-0000-0000-0000-000000000002",
+        "first_name": "",
+        "last_name": "",
+        "email": "[email protected]",
+        "avatar": "",
+        "avatar_url": null,
+        "display_name": "user2",
+    },
+    {
+        "id": "00000000-0000-0000-0000-000000000003",
+        "first_name": "User",
+        "last_name": "Three",
+        "email": "[email protected]",
+        "avatar": "",
+        "avatar_url": null,
+        "display_name": "user3",
+    }
+]
+```

api-reference/members/get-workspace-members.mdx

@@ -0,0 +1,50 @@
+---
+title: Get workspace members
+sidebarTitle: Workspace members
+description: Retrieve the list of all members in a workspace.
+api: GET /api/v1/workspaces/:workspace-slug/members/
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required>
+The workspace-slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
+
+</ParamField>
+
+### Response
+
+```json
+[
+    {
+        "id": "00000000-0000-0000-0000-000000000001",
+        "first_name": "User",
+        "last_name": "One",
+        "email": "[email protected]",
+        "avatar": "",
+        "avatar_url": null,
+        "display_name": "user1",
+        "role": 15
+    },
+    {
+        "id": "00000000-0000-0000-0000-000000000002",
+        "first_name": "",
+        "last_name": "",
+        "email": "[email protected]",
+        "avatar": "",
+        "avatar_url": null,
+        "display_name": "user2",
+        "role": 15
+    },
+    {
+        "id": "00000000-0000-0000-0000-000000000003",
+        "first_name": "User",
+        "last_name": "Three",
+        "email": "[email protected]",
+        "avatar": "",
+        "avatar_url": null,
+        "display_name": "user3",
+        "role": 20
+    }
+]
+```

api-reference/members/overview.mdx

@@ -0,0 +1,52 @@
+---
+title: Overview
+description: APIs to retrieve members of a workspace and the individual projects within it.
+---
+
+```http
+GET    /api/v1/workspaces/:workspace-slug/members/
+GET    /api/v1/workspaces/:workspace-slug/projects/:project_id/members/
+```
+
+## Member object
+**Attributes**
+
+*   `id` _string_  
+    Unique identifier for the Member
+
+*   `first_name` _string_  
+    First name of the Member
+
+*   `last_name` _string_  
+    Last name of the Member
+
+*   `email` _string_  
+    Email address of the Member
+
+*   `avatar` _string_  
+    Optional avatar image file reference
+
+*   `avatar_url` _string_  
+    Publicly accessible URL for the avatar image
+
+*   `display_name` _string_  
+    Display name shown across the application
+
+*   `role` _integer_  
+    Role of the Member in the Workspace or Project
+
+
+<ResponseExample>
+```json JSON
+    {
+        "id": "00000000-0000-0000-0000-000000000001",
+        "first_name": "User",
+        "last_name": "One",
+        "email": "[email protected]",
+        "avatar": "",
+        "avatar_url": null,
+        "display_name": "user1",
+        "role": 15
+    }
+```
+</ResponseExample>

mint.json

@@ -324,6 +324,14 @@
             "api-reference/worklogs/update-worklog",
             "api-reference/worklogs/delete-worklog"
           ]
+        },
+        {
+          "group": "Members",
+          "pages": [
+            "api-reference/members/overview",
+            "api-reference/members/get-workspace-members",
+            "api-reference/members/get-project-members"
+          ]
         }
       ]
     },