āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā ā š shadcn/directory/clerk/clerk-docs/reference/backend/organization/get-organization-list ā āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
getOrganizationList()'
description: Use Clerk's JS Backend SDK to retrieve a list of organizations.
sdk: js-backend{/* clerk/javascript file: https://github.com/clerk/javascript/blob/main/packages/backend/src/api/endpoints/OrganizationApi.ts#L101 */}
Retrieves a list of organizations. Returns a PaginatedResourceResponse object with a data property that contains an array of Organization objects, and a totalCount property that indicates the total number of organizations in the system.
function getOrganizationList(
params: GetOrganizationListParams,
): Promise<PaginatedResourceResponse<Organization[]>>
GetOrganizationListParamsThe 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.
offset?numberSkip 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.
includeMembersCount?booleanWhether the member counts of each organization should be included in the response or not.
query?stringFilters organizations with ID, name, or slug that match the given query. Uses exact match for organization ID and partial match for name and slug.
orderBy?'name' | 'created_at' | 'members_count'Return organizations in a particular order. Prefix with a - to reverse the order. Prefix with a + to list in ascending order. Defaults to '-created_at'.
</Properties>
const response = await clerkClient.organizations.getOrganizationList()
Retrieves organization list that is filtered by the number of results.
const { data, totalCount } = await clerkClient.organizations.getOrganizationList({
// returns the first 10 results
limit: 10,
})
Retrieves organization list that is filtered by the number of results to skip.
const { data, totalCount } = await clerkClient.organizations.getOrganizationList({
// skips the first 10 results
offset: 10,
})
Retrieves list of organizations that match the query.
// returns organizations that have 'test' in their name
const { data, totalCount } = await clerkClient.organizations.getOrganizationList({ query: 'test' })
This method in the SDK is a wrapper around the BAPI endpoint GET/organizations. See the BAPI reference{{ target: '_blank' }} for more information.
ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā ā
āāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāāā