From df4a157416925939942b273bf5b8b396bef1252d Mon Sep 17 00:00:00 2001
From: Hw <56923450+waddaboo@users.noreply.github.com>
Date: Wed, 26 Jun 2024 20:28:02 +0800
Subject: [PATCH] docs: add getCredentialGroupJoinUrl

---
 apps/docs/docs/api-sdk.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/apps/docs/docs/api-sdk.md b/apps/docs/docs/api-sdk.md
index fe44943b..51c33b49 100644
--- a/apps/docs/docs/api-sdk.md
+++ b/apps/docs/docs/api-sdk.md
@@ -377,3 +377,27 @@ const apiKey = "70f07d0d-6aa2-4fe1-b4b9-06c271a641dc"
 
 const invite = await apiSdk.getInvite(inviteCode)
 ```
+
+## Get credential group join URL
+
+\# **getCredentialGroupJoinUrl**(): _string_
+
+Returns a custom URL string for joining a credential group.
+
+```ts
+import { DashboardUrl } from "@bandada/api-sdk"
+
+const dashboardUrl = DashboardUrl.DEV
+const groupId = "10402173435763029700781503965100"
+const commitment = "1"
+const providerName = "github"
+const redirectUri = "http://localhost:3003"
+
+const url = apiSdk.getCredentialGroupJoinUrl(
+    dashboardUrl,
+    groupId,
+    commitment,
+    providerName,
+    redirectUri
+)
+```