Docs

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

getPendingOrganizationInvitationList()

Retrieves a list of organization invitations that have not yet been accepted.

const organizationId = 'my-organization-id';

const invitations = await clerkClient.organizations.getPendingOrganizationInvitationList({ organizationId });

GetPendingOrganizationInvitationListParams

  • Name
    organizationId
    Type
    string
    Description

    The ID of the organization to retrieve the list of pending invitations from.

  • Name
    limit?
    Type
    number
    Description

    The number of results to return. Must be an integer greater than zero and less than 501.

  • Name
    offset?
    Type
    number
    Description

    The number of results to skip.

Examples

getPendingOrganizationInvitationList({ limit })

Retrieves organization invitation list that is filtered by the number of results.

const organizationId = 'my-organization-id';

const invitations = await clerkClient.organizations.getPendingOrganizationInvitationList({
  organizationId,
  // returns the first 10 results
  limit: 10,
});

getPendingOrganizationInvitationList({ offset })

Retrieves organization invitation list that is filtered by the number of results to skip.

const organizationId = 'my-organization-id';

const invitations = await clerkClient.organizations.getPendingOrganizationInvitationList({
  organizationId,
  // skips the first 10 results
  offset: 10,
});

Feedback

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

Last updated on