Get Clerk instance communication settings

Retrieve SMS communication settings for a connected Clerk instance.

← All Clerk endpoints · Capability overview

GET/v1/clerk/instance-communication-settings

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

3 tokens

Retrieve SMS communication 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_communication_settings

Parameters1 field

clerk_instance_idstringOptional

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

Response3 fields

communication_settingsobject

2 fields

Clerk instance communication settings from the Backend API.

objectstring

Clerk object type for communication settings.

blocked_country_codesstring[]

ISO country codes blocked from receiving SMS messages.

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

200Communication settings for a connected Clerk instance.

communication_settings.json

{
  "communication_settings": {
    "object": "instance_communication_settings",
    "blocked_country_codes": [
      "CN",
      "RU"
    ]
  }
}