Docs

You are viewing an archived version of the docs.Go to latest version

getInvitationList()

Retrieves a list of all non-revoked invitations for your application, sorted by descending creation date.

const invitations = await clerkClient.invitations.getInvitationList();
  • Name
    status?
    Type
    accepted | pending | revoked
    Description

    Filter by invitation status.

Example

getInvitationList({ status })

Retrieves list of invitations that have been revoked.

// get all revoked invitations
const invitations = await clerkClient.invitations.getInvitationList({ status: 'revoked'});

Feedback

What did you think of this content?

Last updated on