Get Clerk instance settings

Retrieve core settings for a connected Clerk application instance.

← All Clerk endpoints · Capability overview

GET/v1/clerk/instance-settings

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

3 tokens

Retrieve core settings for a connected Clerk application 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_settings

Parameters1 field

clerk_instance_idstringOptional

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

Response12 fields

instance_settingsobject

11 fields

Core Clerk instance settings from the Backend API.

objectstring

Clerk object type for the instance.

idstring

Clerk instance id (ins_...).

environment_typestring

Instance environment type (development or production).

allowed_originsstring[]

Allowed browser origins for the instance.

test_modeboolean

Whether the instance is in test mode.

hibpboolean

Whether Have I Been Pwned password checking is enabled.

support_emailstring

Support email address shown to end users.

clerk_js_versionstring

Pinned Clerk.js version for the instance, when set.

development_originstring

Development origin URL for local testing.

url_based_session_syncingboolean

Whether URL-based session syncing is enabled.

preferred_sign_in_strategy_when_password_requiredstring

Preferred sign-in strategy when a password is required: "password" or "otp".

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-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

200Core settings for a connected Clerk instance.

instance_settings.json

{
  "instance_settings": {
    "object": "instance",
    "id": "ins_2abc123",
    "environment_type": "production",
    "allowed_origins": [
      "https://example.com"
    ],
    "test_mode": false,
    "hibp": true,
    "support_email": "support@example.com",
    "clerk_js_version": null,
    "development_origin": null,
    "url_based_session_syncing": false,
    "preferred_sign_in_strategy_when_password_required": "password"
  }
}