`getOrganizationInvitationList()`

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


const organizationId = 'my-organization-id';
 
const invitations = await clerkClient.organizations.getOrganizationInvitationList({ organizationId });

`GetOrganizationInvitationListParams`

Name	Type	Description
`organizationId`	`string`	The ID of the organization to retrieve the list of pending invitations from.
`status?`	[ 'pending'	'accepted'
`limit?`	`number`	The number of results to return. Must be an integer greater than zero and less than 500.
`offset?`	`number`	The number of results to skip.

Examples

`getOrganizationInvitationList({ status })`

Retrieves organization invitation list that is filtered by the status of the invitation.


const organizationId = 'my-organization-id';
 
const invitations = await clerkClient.organizations.getOrganizationInvitationList({
  organizationId,
  // returns a list of invitations that have not yet been accepted
  status: [ 'pending' ],
});

`getOrganizationInvitationList({ limit })`

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


const organizationId = 'my-organization-id';
 
const invitations = await clerkClient.organizations.getOrganizationInvitationList({
  organizationId,
  // returns the first 10 results
  limit: 10,
});

`getOrganizationInvitationList({ 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.getOrganizationInvitationList({
  organizationId,
  // skips the first 10 results
  offset: 10,
});