Skip to content

chore(backend): Introduce include_members_count parameter to getOrganization #4196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2024
Merged

chore(backend): Introduce include_members_count parameter to getOrganization #4196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/light-geckos-allow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/backend": patch
---

Introduce `includeMembersCount` parameter to `getOrganization`, allowing to retrieve an organization with `membersCount`.
8 changes: 7 additions & 1 deletion packages/backend/src/api/endpoints/OrganizationApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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,
},
});
}

Expand Down