Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerkstage.dev

getOrganizationMembershipList()

Retrieves a list of memberships for an organization.

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

GetOrganizationMembershipListParams

NameTypeDescription
organizationIdstringThe ID of the organization to retrieve the list of memberships from.
limit?numberThe number of results to return. Must be an integer greater than zero and less than 500.
offset?numberThe 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, });

What did you think of this content?

Clerk © 2024