Skip to main content

getOrganizationSettings()

Gets the Organization-related settings for the current instance.

Returns the OrganizationSettings object.

function getOrganizationSettings(): Promise<OrganizationSettings>

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.instances.getOrganizationSettings()

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint GET/instance/organization_settings. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on