chore(backend): Introduce include_members_count parameter to `getOr…

…ganization` (#4196)
clerk · Sep 24, 2024 · 418be2f · 418be2f
1 parent 99de68d
commit 418be2f
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.changeset/light-geckos-allow.md b/.changeset/light-geckos-allow.md
@@ -0,0 +1,5 @@
+---
+"@clerk/backend": patch
+---
+
+Introduce `includeMembersCount` parameter to `getOrganization`, allowing to retrieve an organization with `membersCount`.
diff --git a/packages/backend/src/api/endpoints/OrganizationApi.ts b/packages/backend/src/api/endpoints/OrganizationApi.ts
@@ -34,7 +34,9 @@ type CreateParams = {
   maxAllowedMemberships?: number;
 } & MetadataParams;
 
-type GetOrganizationParams = { organizationId: string } | { slug: string };
+type GetOrganizationParams = ({ organizationId: string } | { slug: string }) & {
+  includeMembersCount?: boolean;
+};
 
 type UpdateParams = {
   name?: string;
@@ -115,12 +117,16 @@ export class OrganizationAPI extends AbstractAPI {
   }
 
   public async getOrganization(params: GetOrganizationParams) {
+    const { includeMembersCount } = params;
     const organizationIdOrSlug = 'organizationId' in params ? params.organizationId : params.slug;
     this.requireId(organizationIdOrSlug);
 
     return this.request<Organization>({
       method: 'GET',
       path: joinPaths(basePath, organizationIdOrSlug),
+      queryParams: {
+        includeMembersCount,
+      },
     });
   }