Get Clerk instance

Retrieve the connected Clerk application instance id and environment type.

← All Clerk endpoints · Capability overview

GET/v1/clerk/instance

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

2 tokens

Retrieve the connected Clerk application instance id and environment type.

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

Parameters1 field

clerk_instance_idstringOptional

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

Response3 fields

instanceobject

2 fields

Connected Clerk instance metadata.

idstring

Clerk instance id (ins_...).

environment_typestring

Clerk environment: development or production.

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

200Development Clerk instance for the default connected account.

development_instance.json

{
  "instance": {
    "id": "ins_2abc123",
    "environment_type": "development"
  }
}