getOrganizationMembershipList()
Retrieves a list of memberships for an organization.
const organizationId = 'my-organization-id';
const memberships = await clerkClient.organizations.getOrganizationMembershipList({ organizationId });- Name
organizationId- Type
string- Description
The ID of the organization to retrieve the list of memberships 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
getOrganizationMembershipList({ limit })
Retrieves organization membership list that is filtered by the number of results.
const organizationId = 'my-organization-id';
const memberships = await clerkClient.organizations.getOrganizationMembershipList({
organizationId,
// returns the first 10 memberships
limit: 10,
});getOrganizationMembershipList({ offset })
Retrieves organizaiton membership list that is filtered by the number of results to skip.
const organizationId = 'my-organization-id';
const memberships = await clerkClient.organizations.getOrganizationMembershipList({
organizationId,
// skips the first 10 memberships
offset: 10,
});Feedback
Last updated on