fix: add query to GetInvitationListParams

clerk · Dec 18, 2024 · 95e0d6a · 95e0d6a
1 parent 4e34a3a
commit 95e0d6a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/.changeset/spotty-berries-bake.md b/.changeset/spotty-berries-bake.md
@@ -0,0 +1,5 @@
+---
+'@clerk/backend': patch
+---
+
+add `query` to `GetInvitationListParams`
diff --git a/packages/backend/src/api/endpoints/InvitationApi.ts b/packages/backend/src/api/endpoints/InvitationApi.ts
@@ -24,10 +24,21 @@ type GetInvitationListParams = ClerkPaginationRequest<{
    *
    * import { createClerkClient } from '@clerk/backend';
    * const clerkClient = createClerkClient(...)
-   * await clerkClient.invitations.getInvitationList({ status: 'revoked })
+   * await clerkClient.invitations.getInvitationList({ status: 'revoked' })
    *
    */
   status?: 'accepted' | 'pending' | 'revoked';
+  /**
+   * Filters invitations based on `email_address` or `id`.
+   *
+   * @example
+   * get all invitations for a specific email address
+   * import { createClerkClient } from '@clerk/backend';
+   * const clerkClient = createClerkClient(...)
+   * await clerkClient.invitations.getInvitationList({ query: '[email protected]' })
+   *
+   */
+  query?: string;
 }>;
 
 export class InvitationAPI extends AbstractAPI {