Skip to main content
Docs

getOrganizationInvitation()

Retrieves an .

function getOrganizationInvitation(
  params: GetOrganizationInvitationParams,
): Promise<OrganizationInvitation>

GetOrganizationInvitationParams

  • Name
    organizationId
    Type
    string
    Description

    The ID of the organization that the invitation is for.

  • Name
    invitationId
    Type
    string
    Description

    The ID of the invitation to retrieve.

Example

Note

Importing clerkClient varies based on your framework. Refer to the for usage details, including guidance on .

const organizationId = 'org_123'

const invitationId = 'orginv_123'

const response = await clerkClient.organizations.getOrganizationInvitation({
  organizationId,
  invitationId,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/organizations/{organization_id}/invitations/{invitation_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on