Clerk API (unofficial showcase)
GET/instance/organization_settings

Get instance organization settings

Retrieves the organization settings of the instance

4 status codes
200Success
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:organization_settings
enabledbooleanrequired
max_allowed_membershipsintegerrequired
max_allowed_rolesintegerrequired
max_role_sets_allowedintegeroptional
max_allowed_domainsintegerrequired
max_allowed_permissionsintegerdeprecatedoptional
max_allowed_permissions is now a no-op, as permissions are now unlimited
creator_rolestringrequired
The role key that a user will be assigned after creating an organization.
admin_delete_enabledbooleanrequired
The default for whether an admin can delete an organization with the Frontend API.
domains_enabledbooleanrequired
slug_disabledbooleanoptional
domains_enrollment_modesarray<string>required
domains_default_rolestringrequired
The role key that it will be used in order to create an organization invitation or suggestion.
initial_role_set_keystringoptional
The role set key that it will be used to create new organizations.
402Payment required
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 402 is returned: Payment required. A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters.