From d3133913ec96cac52471093dde16117efb275ddf Mon Sep 17 00:00:00 2001
From: simon-sarrafi <simon.sarrafi@saucelabs.com>
Date: Fri, 22 Nov 2024 17:01:12 +0100
Subject: [PATCH] [TF-2155] Add and list groups (#3021)

* [TF-2155] Add and list groups

* [TF-2155] Add and list groups

* [TF-2155] Add and list groups - minor correction
---
 docs/testfairy/api-reference/rest-api.md | 107 +++++++++++++++++++++++
 1 file changed, 107 insertions(+)

diff --git a/docs/testfairy/api-reference/rest-api.md b/docs/testfairy/api-reference/rest-api.md
index ddda477522..715673e703 100644
--- a/docs/testfairy/api-reference/rest-api.md
+++ b/docs/testfairy/api-reference/rest-api.md
@@ -219,6 +219,7 @@ Delete a specific build. When all builds of a project are deleted, the project i
 <p></p>
 
 Use this endpoint to copy a specific build to a specified folder. You can either create a new folder or copy the build to an existing one.
+
 #### Parameters
 
 <table id="table-api">
@@ -660,6 +661,9 @@ Add a single or multiple testers to a specific group.
 
 Remove a single or multiple testers from a specific group.
 
+<p></p>
+**Note:** Groups without any members will be discarded.
+
 #### Parameters
 
 <table id="table-api">
@@ -698,6 +702,109 @@ Remove a single or multiple testers from a specific group.
 
 </details>
 
+---
+
+### List All Tester groups
+
+<details>
+<summary><span className="api get">GET</span><code>/api/1/testers/groups</code></summary>
+<p></p>
+
+List all tester groups in this account.
+
+#### Responses
+
+<table id="table-api">
+	<tbody>
+		<tr>
+			<td><code>200</code></td>
+			<td colSpan='2'>Success.</td>
+		</tr>
+	</tbody>
+</table>
+
+```json title="Sample Response"
+{
+  "status": "ok",
+  "groups": [
+    {
+      "id": 14,
+      "name": "group1",
+      "testers": [
+        [
+          {
+            "email": "tester1@saucelabs.com"
+          },
+          {
+            "email": "tester2@saucelabs.com"
+          },
+          {
+            "email": "tester3@saucelabs.com"
+          }
+        ]
+      ]
+    },
+    {
+      "id": 39,
+      "name": "group2",
+      "testers": [
+        [
+          {
+            "email": "tester1@saucelabs.com"
+          }
+        ]
+      ]
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### Create a Tester Group
+
+<details>
+<summary><span className="api post">POST</span><code>/api/1/testers/groups</code></summary>
+<p></p>
+
+Create a new tester group
+
+#### Parameters
+
+<table id="table-api">
+  	<tbody>
+		<tr>
+			<td><code>groupName</code></td>
+			<td><p><small>| REQUIRED | STRING |</small></p><p>Specify a group name.</p></td>
+		</tr>
+	</tbody>
+</table>
+
+#### Responses
+
+<table id="table-api">
+	<tbody>
+		<tr>
+			<td><code>200</code></td>
+			<td colSpan='2'>Success.</td>
+		</tr>
+	</tbody>
+</table>
+
+```json title="Sample Response"
+{
+    "status": "ok",
+    "id": "40",
+    "name": "group3"
+}
+```
+
+</details>
+
+---
+
 ## Feedbacks
 
 ### Get Latest Recorded Feedbacks