Docs

getOrganizationMembershipList()

Retrieves a list of memberships for an organization.

function getOrganizationMembershipList(
  params: GetOrganizationMembershipListParams,
): Promise<PaginatedResourceResponse<OrganizationMembership[]>>

GetOrganizationMembershipListParams

  • 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. Can be used for paginating the results together with offset. Defaults to 10.

  • Name
    offset?
    Type
    number
    Description

    Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit. Defaults to 0.

  • Name
    orderBy?
    Type
    'phone_number' | 'email_address' | 'created_at' | 'first_name' | 'last_name' | 'username'
    Description

    Return memberships in a particular order. Prefix with a - to reverse the order. Prefix with a + to list in ascending order. Defaults to '-created_at'.

Examples

Basic

In the following example, you can see that the returned PaginatedResourceResponse includes data, which is an array of OrganizationMembership objects, and totalCount, which indicates the total number of organization memberships in the system for the specified organization.

const organizationId = 'org_2ZUtbk2yvnFGItdeze1ivCh3uqh'

const response = await clerkClient.organizations.getOrganizationMembershipList({ organizationId })

console.log(response)
/* In this example, you can see that data is an array of OrganizationMembership objects, and is populated with two OrganizationMemberships.
{
  data: [
    _OrganizationMembership {
      id: 'orgmem_2b6TUmlDXlo3e9XPq3Wd9EyfIfj',
      role: 'org:member',
      publicMetadata: {},
      privateMetadata: {},
      createdAt: 1705534546701,
      updatedAt: 1705534546701,
      organization: [_Organization],
      publicUserData: [_OrganizationMembershipPublicUserData]
    },
    _OrganizationMembership {
      id: 'orgmem_2ZUtbeklm2DPSy7jsaLLwf6V8Nq',
      role: 'org:admin',
      publicMetadata: {},
      privateMetadata: {},
      createdAt: 1702488558867,
      updatedAt: 1702488558867,
      organization: [_Organization],
      publicUserData: [_OrganizationMembershipPublicUserData]
    }
  ],
  totalCount: 2
}
*/

getOrganizationMembershipList({ organizationId, limit })

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

const organizationId = 'org_123'

const { data, totalCount } = await clerkClient.organizations.getOrganizationMembershipList({
  organizationId,
  // returns the first 10 memberships
  limit: 10,
})

getOrganizationMembershipList({ organizationId, offset })

Retrieves organizaiton membership list that is filtered by the number of results to skip.

const organizationId = 'org_123'

const { data, totalCount } = await clerkClient.organizations.getOrganizationMembershipList({
  organizationId,
  // skips the first 10 memberships
  offset: 10,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/organizations/{organization_id}/memberships. See the BAPI reference for more information.

Feedback

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

Last updated on