Get Clerk instance organization settings

Retrieve organization feature settings for a connected Clerk instance.

← All Clerk endpoints · Capability overview

GET/v1/clerk/instance-organization-settings

https://api.vee3.io/v1/clerk/instance-organization-settings

3 tokens

Retrieve organization feature settings for a connected Clerk instance.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.get_instance_organization_settings

Parameters1 field

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Response15 fields

organization_settingsobject

14 fields

Clerk instance organization settings from the Backend API.

objectstring

Clerk object type for organization settings.

enabledboolean

Whether organizations are enabled for the instance.

max_allowed_membershipsinteger

Maximum organization memberships allowed per user.

max_allowed_rolesinteger

Maximum custom roles allowed per organization.

max_role_sets_allowedinteger

Maximum role sets allowed per organization.

max_allowed_domainsinteger

Maximum verified domains allowed per organization.

creator_rolestring

Default role assigned to the organization creator.

admin_delete_enabledboolean

Whether organization admins can delete their organization.

domains_enabledboolean

Whether organization domains are enabled.

slug_disabledboolean

Whether organization slugs are disabled.

domains_enrollment_modesarrayitems

1 field

Allowed organization domain enrollment modes.

itemstring

An enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

domains_default_rolestring

Default role for members who join via a verified organization domain.

initial_role_set_keystring

Initial role set key applied to new organizations.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/instance-organization-settings"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {

}

response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization settings for a connected Clerk instance.

organization_settings.json

{
  "organization_settings": {
    "object": "instance_organization_settings",
    "enabled": true,
    "max_allowed_memberships": 10,
    "max_allowed_roles": 10,
    "max_role_sets_allowed": 1,
    "max_allowed_domains": 5,
    "creator_role": "org:admin",
    "admin_delete_enabled": true,
    "domains_enabled": true,
    "slug_disabled": false,
    "domains_enrollment_modes": [
      "automatic_invitation"
    ],
    "domains_default_role": "org:member",
    "initial_role_set_key": null
  }
}