Clerk

Clerk API for agents: users, organizations, sessions, invitations, billing, API keys, machines, webhooks, and instance settings in the user's own Clerk application.

GET/v1/clerk/connected-accounts

https://api.vee3.io/v1/clerk/connected-accounts

0 tokens

List active Clerk applications connected to the authenticated Vee3 account.

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_connected_accounts

Parameters0 fields

Response5 fields

accountsarrayitems

4 fields

Active connected Clerk applications for the authenticated Vee3 account.

clerk_instance_idstring

Clerk instance id (ins_...) to pass as clerk_instance_id on Clerk calls.

display_namestring

Connected Clerk application label shown in the dashboard.

environment_typestring

Clerk environment for the connection: development or production.

is_defaultboolean

Whether this account is used when clerk_instance_id is omitted on Clerk calls.

HTTP errors: unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/connected-accounts"
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 responses2 examples

200No Clerk applications connected yet.

no_connected_accounts.json

{
  "accounts": []
}

200One connected Clerk development application marked as default.

one_connected_account.json

{
  "accounts": [
    {
      "clerk_instance_id": "ins_2abc123",
      "display_name": "test-app · Development",
      "environment_type": "development",
      "is_default": true
    }
  ]
}

GET/v1/clerk/users

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

5 tokens

List users in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of users to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of users to skip before returning results.

Default: 0 · min 0

Response7 fields

usersarrayitems

5 fields

Users returned for the requested page.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

total_countinteger

Total number of users in the Clerk application.

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/users"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200First page of users from a connected Clerk application.

user_page.json

{
  "users": [
    {
      "id": "user_2abc123",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "primary_email_address": "ada@example.com",
      "created_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/users/{user_id}

https://api.vee3.io/v1/clerk/users/{user_id}

3 tokens

Retrieve one Clerk user by id.

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_user

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve.

Response6 fields

userobject

5 fields

Requested Clerk user summary.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123"
}

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

Example responses1 example

200Clerk user retrieved by id.

user_found.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

POST/v1/clerk/users

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

10 tokens

Create a user in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

email_addressstringRequired

Primary email address for the new Clerk user.

first_namestringOptional

Optional first name.

last_namestringOptional

Optional last name.

passwordstringOptional

Optional password. Omit to create a user without a password.

Response9 fields

userobject

8 fields

Created Clerk user object from the Backend API.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

email_addressesarrayitems

2 fields

Email addresses associated with the user.

idstring

Email address identifier.

email_addressstring

Email address value.

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/users"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "email_address": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk user.

created_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "email_addresses": [
      {
        "id": "idn_2abc123",
        "email_address": "ada@example.com"
      }
    ],
    "created_at": 1710000000000
  }
}

PATCH/v1/clerk/users/{user_id}

https://api.vee3.io/v1/clerk/users/{user_id}

8 tokens

Update profile fields for a Clerk user.

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

Parameters6 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to update.

first_namestringOptional

Optional first name.

last_namestringOptional

Optional last name.

usernamestringOptional

Optional username.

external_idstringOptional

Optional external id for the user.

Response6 fields

userobject

5 fields

Updated Clerk user summary.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after a profile update.

updated_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

GET/v1/clerk/organizations

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

5 tokens

List organizations in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

querystringOptional

Optional search string to filter organizations by name or slug.

limitintegerOptional

Maximum number of organizations to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of organizations to skip before returning results.

Default: 0 · min 0

Response7 fields

organizationsarrayitems

5 fields

Organizations returned for the requested page.

idstring

Clerk organization id (org_...).

namestring

Organization display name.

slugstring

URL-friendly organization slug, if set.

members_countinteger

Current number of members in the organization.

created_atinteger

Unix timestamp in milliseconds when the organization was created.

total_countinteger

Total number of organizations in the Clerk application.

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/organizations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200First page of organizations from a connected Clerk application.

organization_page.json

{
  "organizations": [
    {
      "id": "org_2abc123",
      "name": "Acme Corp",
      "slug": "acme-corp",
      "members_count": 12,
      "created_at": 1710000000000
    }
  ],
  "total_count": 1
}

POST/v1/clerk/organizations

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

10 tokens

Create a new organization in a connected Clerk application.

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

Parameters7 fields

clerk_instance_idstringOptional

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

namestringRequired

Organization display name.

created_bystringRequired

Clerk user id (user_...) of the user creating the organization.

slugstringOptional

Optional URL-friendly slug for the organization.

max_allowed_membershipsintegerOptional

Optional maximum number of memberships allowed.

public_metadataobjectOptional

Optional public metadata as a JSON object.

private_metadataobjectOptional

Optional private metadata as a JSON object.

Response6 fields

organizationobject

5 fields

Newly created Clerk organization summary.

idstring

Clerk organization id (org_...).

namestring

Organization display name.

slugstring

URL-friendly organization slug, if set.

members_countinteger

Current number of members in the organization.

created_atinteger

Unix timestamp in milliseconds when the organization was created.

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/organizations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "created_by": "example"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A newly created Clerk organization.

created_organization.json

{
  "organization": {
    "id": "org_2abc123",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "members_count": 1,
    "created_at": 1710000000000
  }
}

GET/v1/clerk/organizations/{organization_id}/memberships

https://api.vee3.io/v1/clerk/organizations/{organization_id}/memberships

5 tokens

List members of an organization in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) whose members to list.

limitintegerOptional

Maximum number of organization memberships to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of organization memberships to skip before returning results.

Default: 0 · min 0

Response6 fields

membershipsarrayitems

4 fields

Memberships returned for the requested page.

idstring

Clerk organization membership id (orgmem_...).

user_idstring

Clerk user id (user_...) of the member.

rolestring

Role of the member in the organization (e.g. org:admin, org:member).

created_atinteger

Unix timestamp in milliseconds when the membership was created.

total_countinteger

Total number of members in the organization.

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/organizations/{organization_id}/memberships"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789"
}

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

Example responses1 example

200First page of members from a Clerk organization.

membership_page.json

{
  "memberships": [
    {
      "id": "orgmem_2abc123",
      "user_id": "user_2abc123",
      "role": "org:member",
      "created_at": 1710000000000
    }
  ],
  "total_count": 1
}

POST/v1/clerk/organizations/{organization_id}/invitations

https://api.vee3.io/v1/clerk/organizations/{organization_id}/invitations

10 tokens

Invite an email address to join a Clerk organization with a specific role.

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

Parameters4 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

email_addressstringRequired

Email address to invite.

rolestringRequired

Role to assign to the invitee (e.g. org:admin, org:member).

Response6 fields

invitationobject

5 fields

Created organization invitation summary.

idstring

Clerk organization invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

rolestring

Role assigned to the invitee (e.g. org:admin, org:member).

statusstring

Invitation status: pending, accepted, or revoked.

organization_idstring

Clerk organization id (org_...) that owns this invitation.

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/organizations/{organization_id}/invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "organization_id": "org_2xyz789",
    "email_address": "ada@example.com",
    "role": "org:member"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created organization invitation.

created_invitation.json

{
  "invitation": {
    "id": "inv_2abc123",
    "email_address": "ada@example.com",
    "role": "org:member",
    "status": "pending",
    "organization_id": "org_2xyz456"
  }
}

GET/v1/clerk/sessions

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

5 tokens

List sessions in a connected Clerk application.

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

Parameters6 fields

clerk_instance_idstringOptional

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

user_idstringOptional

Filter sessions to those belonging to this Clerk user id (user_...). Clerk requires user_id or client_id when listing sessions; pass user_id here.

client_idstringOptional

Filter sessions to those belonging to this Clerk client id (client_...).

statusstringOptional

Filter sessions by status. Accepted values: abandoned, active, ended, expired, removed, replaced, revoked.

limitintegerOptional

Maximum number of sessions to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of sessions to skip before returning results.

Default: 0 · min 0

Response7 fields

sessionsarrayitems

5 fields

Sessions returned for the requested page.

idstring

Clerk session id (sess_...).

user_idstring

Clerk user id (user_...) that owns this session.

statusstring

Current status of the session.

last_active_atinteger

Unix timestamp in milliseconds of the last activity on this session.

expire_atinteger

Unix timestamp in milliseconds when this session expires.

total_countinteger

Total number of sessions returned.

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/sessions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123",
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200First page of active sessions from a connected Clerk application.

sessions_page.json

{
  "sessions": [
    {
      "id": "sess_2abc123",
      "user_id": "user_2abc123",
      "status": "active",
      "last_active_at": 1710000000000,
      "expire_at": 1710086400000
    }
  ],
  "total_count": 1
}

POST/v1/clerk/invitations

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

10 tokens

Invite an email address to sign up for a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

email_addressstringRequired

Email address to invite.

rolestringOptional

Optional role to assign when the invitation is accepted.

redirect_urlstringOptional

Optional URL to redirect the invitee to after accepting.

public_metadataobjectOptional

Optional public metadata as a JSON object attached to the invitation.

Response6 fields

invitationobject

5 fields

Created Clerk invitation object from the Backend API.

idstring

Clerk invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

statusstring

Invitation status: "pending", "accepted", "revoked", or "expired".

created_atinteger

Unix timestamp in milliseconds when the invitation was created.

revokedboolean

Whether the invitation has been revoked.

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/invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "email_address": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk invitation.

created_invitation.json

{
  "invitation": {
    "id": "inv_2abc123",
    "email_address": "ada@example.com",
    "status": "pending",
    "created_at": 1710000000000,
    "revoked": false
  }
}

GET/v1/clerk/invitations

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

5 tokens

List application invitations in 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.list_invitations

Parameters4 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of invitations to return (1–500).

Default: 10

offsetintegerOptional

Number of invitations to skip before returning results.

Default: 0

statusstringOptional

Optional status filter: "pending", "accepted", "revoked", or "expired".

Response7 fields

invitationsarrayitems

5 fields

Invitations returned for the requested page.

idstring

Clerk invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

statusstring

Invitation status: "pending", "accepted", "revoked", or "expired".

created_atinteger

Unix timestamp in milliseconds when the invitation was created.

revokedboolean

Whether the invitation has been revoked.

total_countinteger

Total number of invitations returned on this page.

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/invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "status": "example"
}

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

Example responses1 example

200First page of invitations from a connected Clerk instance.

invitation_page.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "email_address": "ada@example.com",
      "status": "pending",
      "created_at": 1710000000000,
      "revoked": false
    }
  ],
  "total_count": 1
}

GET/v1/clerk/api-keys

https://api.vee3.io/v1/clerk/api-keys

5 tokens

List API keys for a subject in a connected Clerk application.

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

Parameters7 fields

clerk_instance_idstringOptional

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

subjectstringRequired

Subject to list API keys for (user_... or org_...).

key_typestringOptional

Filter by API key type (typically "api_key").

include_invalidbooleanOptional

When true, include revoked or expired API keys.

limitintegerOptional

Maximum number of API keys to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of API keys to skip before returning results.

Default: 0 · min 0

querystringOptional

Search query to filter API keys by name.

Response18 fields

api_keysarrayitems

16 fields

API keys matching the request.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject

1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems

1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

total_countinteger

Total number of API keys matching the filters.

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/api-keys"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "subject": "user_2abc123"
}

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

Example responses1 example

200API keys for a subject.

api_key_list.json

{
  "api_keys": [
    {
      "id": "ak_2abc123",
      "name": "server-integration",
      "subject": "user_2abc123",
      "type": "api_key",
      "revoked": false,
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

POST/v1/clerk/api-keys

https://api.vee3.io/v1/clerk/api-keys

10 tokens

Create an API key for a subject in a connected Clerk application.

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

Parameters9 fields

clerk_instance_idstringOptional

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

namestringRequired

Human-readable name for the new API key.

subjectstringRequired

Subject the API key is scoped to (user_... or org_...).

key_typestringOptional

API key type (typically "api_key").

descriptionstringOptional

Optional description for the API key.

claimsobjectOptional

Custom claims to embed in tokens minted from this API key.

scopesarrayOptional

Permission scopes to grant the API key.

created_bystringOptional

User id to record as the creator of this API key.

seconds_until_expirationnumberOptional

Seconds from creation until the API key expires.

Response17 fields

api_keyobject

16 fields

Newly created Clerk API key from the Backend API.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject

1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems

1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

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/api-keys"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "subject": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk API key with secret.

created_api_key.json

{
  "api_key": {
    "id": "ak_2abc123",
    "name": "server-integration",
    "subject": "user_2abc123",
    "type": "api_key",
    "secret": "ak_live_example_secret",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/billing/plans

https://api.vee3.io/v1/clerk/billing/plans

5 tokens

List billing plans in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

paginatedbooleanOptional

Whether to return paginated results with total_count.

limitintegerOptional

Maximum number of billing plans to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of billing plans to skip before returning results.

Default: 0 · min 0

payer_type"user" | "org"Optional

Filter by payer type: "user" or "org".

Response13 fields

billing_plansarrayitems

11 fields

Billing plans in the connected Clerk application.

idstring

Clerk billing plan id.

namestring

Billing plan display name.

slugstring

Billing plan slug.

descriptionstring

Billing plan description.

for_payer_typestring

Payer type the plan applies to ("user" or "org").

is_defaultboolean

Whether this is the default plan for its payer type.

is_recurringboolean

Whether the plan bills on a recurring schedule.

publicly_visibleboolean

Whether the plan is visible on public pricing pages.

has_base_feeboolean

Whether the plan includes a base fee.

free_trial_enabledboolean

Whether a free trial is enabled for the plan.

free_trial_daysinteger

Number of free trial days when free_trial_enabled is true.

total_countinteger

Total number of billing plans matching the query.

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/billing/plans"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "paginated": False
}

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

Example responses1 example

200Billing plans from a connected Clerk application.

billing_plan_list.json

{
  "billing_plans": [
    {
      "id": "plan_2abc123",
      "name": "Pro",
      "slug": "pro",
      "description": "Professional plan",
      "for_payer_type": "user",
      "is_default": false,
      "is_recurring": true,
      "publicly_visible": true,
      "has_base_fee": true,
      "free_trial_enabled": true,
      "free_trial_days": 14
    }
  ],
  "total_count": 1
}

GET/v1/clerk/jwt-templates

https://api.vee3.io/v1/clerk/jwt-templates

5 tokens

List JWT templates in a connected Clerk application.

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

Parameters1 field

clerk_instance_idstringOptional

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

Response13 fields

jwt_templatesarrayitems

11 fields

JWT templates in the connected Clerk application.

idstring

Clerk JWT template id (jtmp_...).

namestring

Unique template name used when minting tokens from this template.

claimsobject

2 fields

JWT claims template as a JSON object (may include Clerk shortcodes).

audstring

Audience claim when set in the template.

rolestring

Role claim when set in the template.

lifetimeinteger

Token lifetime in seconds (exp claim offset from issuance time).

allowed_clock_skewinteger

Allowed clock skew in seconds for the nbf claim.

created_atinteger

Unix timestamp in milliseconds when the template was created.

updated_atinteger

Unix timestamp in milliseconds when the template was last updated.

signing_algorithmstring

Custom signing algorithm when custom_signing_key is enabled.

custom_signing_keyboolean

Whether this template uses a custom signing key and algorithm.

total_countinteger

Total number of JWT templates.

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/jwt-templates"
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

200JWT templates from a connected Clerk application.

jwt_template_list.json

{
  "jwt_templates": [
    {
      "id": "jtmp_2abc123",
      "name": "supabase",
      "claims": {
        "aud": "authenticated",
        "role": "authenticated"
      },
      "lifetime": 3600,
      "allowed_clock_skew": 5,
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "signing_algorithm": null,
      "custom_signing_key": false
    }
  ],
  "total_count": 1
}

GET/v1/clerk/users/count

https://api.vee3.io/v1/clerk/users/count

2 tokens

Return the total number of users in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

querystringOptional

Optional filter query forwarded to Clerk (email, phone, username, or external id).

Response1 field

total_countinteger

Total number of users in the Clerk application.

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/users/count"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "query": "example"
}

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

Example responses1 example

200Total users in the connected Clerk application.

user_count.json

{
  "total_count": 42
}

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

GET/v1/clerk/jwks

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

2 tokens

Retrieve the JSON Web Key Set for verifying Clerk session tokens.

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_jwks

Parameters1 field

clerk_instance_idstringOptional

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

Response6 fields

jwksobject

5 fields

Clerk JWKS payload from the Backend API.

keysarrayitems

4 fields

Public signing keys for verifying Clerk JWTs.

kidstring

Key id used to match JWT headers to a public key.

algstring

Signing algorithm for the key.

usestring

Key usage, typically "sig" for signing.

ktystring

Key type, for example "RSA" or "EC".

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

200JWKS for a connected Clerk instance.

jwks.json

{
  "jwks": {
    "keys": [
      {
        "kid": "ins_2abc123",
        "alg": "RS256",
        "use": "sig",
        "kty": "RSA"
      }
    ]
  }
}

GET/v1/clerk/api-keys/{api_key_id}

https://api.vee3.io/v1/clerk/api-keys/{api_key_id}

3 tokens

Retrieve API key metadata by id from a connected Clerk application.

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_api_key

Parameters2 fields

clerk_instance_idstringOptional

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

api_key_idstringRequired

Clerk API key id (ak_...) to retrieve, update, delete, or revoke.

Response17 fields

api_keyobject

16 fields

Clerk API key metadata from the Backend API.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject

1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems

1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

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/api-keys/{api_key_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "api_key_id": "ak_2abc123"
}

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

Example responses1 example

200Clerk API key metadata.

api_key_detail.json

{
  "api_key": {
    "id": "ak_2abc123",
    "name": "server-integration",
    "subject": "user_2abc123",
    "type": "api_key",
    "revoked": false,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/billing/statements/{statement_id}

https://api.vee3.io/v1/clerk/billing/statements/{statement_id}

3 tokens

Retrieve a billing statement by id from a connected Clerk application.

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_billing_statement

Parameters2 fields

clerk_instance_idstringOptional

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

statement_idstringRequired

Clerk billing statement id.

Response7 fields

billing_statementobject

6 fields

Billing statement summary.

idstring

Clerk billing statement id.

statusstring

Statement status.

timestampinteger

Unix timestamp in milliseconds for the statement.

payer_idstring

Payer id (user_... or org_...) for the statement.

grand_total_amountinteger

Grand total amount in cents.

grand_total_currencystring

ISO currency code for the grand total.

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/billing/statements/{statement_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "statement_id": "stmt_2abc123"
}

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

Example responses1 example

200A single billing statement.

billing_statement.json

{
  "billing_statement": {
    "id": "stmt_2abc123",
    "status": "paid",
    "timestamp": 1710000000000,
    "payer_id": "user_2abc123",
    "grand_total_amount": 2000,
    "grand_total_currency": "usd"
  }
}

GET/v1/clerk/clients/{client_id}

https://api.vee3.io/v1/clerk/clients/{client_id}

3 tokens

Retrieve a client record by id from 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_client

Parameters2 fields

clerk_instance_idstringOptional

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

client_idstringRequired

Clerk client id to retrieve.

Response7 fields

clientobject

6 fields

Client object from the Backend API.

idstring

Client id.

session_idsarrayitems

1 field

Session ids associated with this client.

session_idstring

Clerk session id (sess_...).

last_active_session_idstring

Most recently active session id for this client.

created_atinteger

Unix timestamp in milliseconds when the client was created.

updated_atinteger

Unix timestamp in milliseconds when the client was last updated.

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/clients/{client_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "client_id": "client_2abc123"
}

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

Example responses1 example

200Clerk client record by id.

client.json

{
  "client": {
    "id": "client_2abc123",
    "session_ids": [
      "sess_2abc123"
    ],
    "last_active_session_id": "sess_2abc123",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/email-addresses/{email_address_id}

https://api.vee3.io/v1/clerk/email-addresses/{email_address_id}

3 tokens

Retrieve a Clerk email address by id.

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_email_address

Parameters2 fields

clerk_instance_idstringOptional

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

email_address_idstringRequired

Clerk email address id (idn_...) to retrieve or modify.

Response8 fields

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

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/email-addresses/{email_address_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "email_address_id": "idn_2abc123"
}

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

Example responses1 example

200Clerk email address retrieved by id.

email_address_found.json

{
  "id": "idn_2abc123",
  "user_id": "user_2abc123",
  "email_address": "ada@example.com",
  "verification_status": "verified",
  "verified": true,
  "primary": true,
  "created_at": 1710000000000,
  "updated_at": 1710000000000
}

GET/v1/clerk/enterprise-connections/{connection_id}

https://api.vee3.io/v1/clerk/enterprise-connections/{connection_id}

3 tokens

Retrieve a single enterprise SSO connection from a connected Clerk application.

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_enterprise_connection

Parameters2 fields

clerk_instance_idstringOptional

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

connection_idstringRequired

Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.

Response36 fields

enterprise_connectionobject

35 fields

Enterprise SSO connection details.

idstring

Enterprise connection id.

namestring

Display name for the connection.

providerstring

Identity provider key (for example saml_custom or oidc_custom).

activeboolean

Whether the connection is active.

domainsstring[]

Email domains that may use this connection.

created_atinteger

Unix timestamp in milliseconds when the connection was created.

updated_atinteger

Unix timestamp in milliseconds when the connection was last updated.

logo_public_urlstring

Public logo URL for the connection when available.

organization_idstring

Linked Clerk organization id (org_...) when the connection is org-scoped.

sync_user_attributesboolean

Whether user attributes sync on each sign-in.

disable_additional_identificationsboolean

Whether users may add additional identifications with this connection.

allow_organization_account_linkingboolean

Whether account linking via organization membership is supported.

custom_attributesarrayitems

5 fields

Custom attribute mappings from the IdP to user metadata.

namestring

Display name for the custom attribute.

keystring

Metadata key used to store the attribute on the user.

sso_pathstring

Path to extract the value from SSO claims.

scim_pathstring

GJSON path to extract the value from SCIM resources.

multi_valuedboolean

Whether the attribute supports multiple values.

saml_connectionobject

9 fields

SAML configuration when the connection uses SAML.

idstring

SAML connection id when the connection uses SAML.

namestring

SAML connection display name.

idp_entity_idstring

Identity Provider entity id.

idp_sso_urlstring

Identity Provider Single Sign-On URL.

acs_urlstring

Assertion Consumer Service URL.

sp_entity_idstring

Service Provider entity id (Clerk).

activeboolean

Whether the SAML connection is active.

allow_idp_initiatedboolean

Whether IdP-initiated SSO is allowed.

allow_subdomainsboolean

Whether email subdomains may use this connection.

oauth_configobject

6 fields

OIDC configuration when the connection uses OAuth.

idstring

OAuth config id when the connection uses OIDC.

namestring

Custom OIDC provider display name.

provider_keystring

OAuth provider key (for example oidc_custom).

client_idstring

OAuth client id.

discovery_urlstring

OIDC discovery URL.

requires_pkceboolean

Whether PKCE is required for this OAuth client.

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/enterprise-connections/{connection_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "connection_id": "conn_2abc123"
}

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

Example responses1 example

200A single enterprise SSO connection.

enterprise_connection_detail.json

{
  "enterprise_connection": {
    "id": "entc_2abc123",
    "name": "Acme SAML",
    "provider": "saml_custom",
    "active": true,
    "domains": [
      "acme.com"
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "sync_user_attributes": true,
    "disable_additional_identifications": false,
    "allow_organization_account_linking": false,
    "saml_connection": {
      "id": "saml_2abc123",
      "name": "Acme SAML",
      "idp_entity_id": "https://idp.acme.com",
      "idp_sso_url": "https://idp.acme.com/sso",
      "acs_url": "https://clerk.example.com/v1/saml/acs",
      "sp_entity_id": "https://clerk.example.com",
      "active": true,
      "allow_idp_initiated": false,
      "allow_subdomains": false
    }
  }
}

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

GET/v1/clerk/instance-oauth-settings

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

3 tokens

Retrieve OAuth 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_oauth_settings

Parameters1 field

clerk_instance_idstringOptional

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

Response4 fields

oauth_settingsobject

3 fields

Clerk instance OAuth settings from the Backend API.

objectstring

Clerk object type for OAuth settings.

dynamic_oauth_client_registrationboolean

Whether dynamic OAuth client registration is enabled.

oauth_jwt_access_tokensboolean

Whether OAuth access tokens are issued as JWTs.

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

200OAuth settings for a connected Clerk instance.

oauth_settings.json

{
  "oauth_settings": {
    "object": "instance_oauth_settings",
    "dynamic_oauth_client_registration": false,
    "oauth_jwt_access_tokens": false
  }
}

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

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

GET/v1/clerk/jwt-templates/{template_id}

https://api.vee3.io/v1/clerk/jwt-templates/{template_id}

3 tokens

Retrieve a single JWT template from a connected Clerk application.

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_jwt_template

Parameters2 fields

clerk_instance_idstringOptional

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

template_idstringRequired

Clerk JWT template id (jtmp_...) to retrieve, update, or delete.

Response12 fields

jwt_templateobject

11 fields

Clerk JWT template details.

idstring

Clerk JWT template id (jtmp_...).

namestring

Unique template name used when minting tokens from this template.

claimsobject

2 fields

JWT claims template as a JSON object (may include Clerk shortcodes).

audstring

Audience claim when set in the template.

rolestring

Role claim when set in the template.

lifetimeinteger

Token lifetime in seconds (exp claim offset from issuance time).

allowed_clock_skewinteger

Allowed clock skew in seconds for the nbf claim.

created_atinteger

Unix timestamp in milliseconds when the template was created.

updated_atinteger

Unix timestamp in milliseconds when the template was last updated.

signing_algorithmstring

Custom signing algorithm when custom_signing_key is enabled.

custom_signing_keyboolean

Whether this template uses a custom signing key and algorithm.

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/jwt-templates/{template_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "template_id": "jtmp_2abc123"
}

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

Example responses1 example

200A single Clerk JWT template.

jwt_template_detail.json

{
  "jwt_template": {
    "id": "jtmp_2abc123",
    "name": "supabase",
    "claims": {
      "aud": "authenticated",
      "role": "authenticated"
    },
    "lifetime": 3600,
    "allowed_clock_skew": 5,
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "signing_algorithm": null,
    "custom_signing_key": false
  }
}

GET/v1/clerk/machines/{machine_id}

https://api.vee3.io/v1/clerk/machines/{machine_id}

3 tokens

Retrieve one machine by id from 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_machine

Parameters2 fields

clerk_instance_idstringOptional

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

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

Response8 fields

machineobject

7 fields

Machine object from the Backend API.

idstring

Machine id (mch_...).

namestring

Machine display name.

instance_idstring

Clerk instance id (ins_...) that owns the machine.

default_token_ttlinteger

Default token lifetime in seconds for tokens created by this machine.

secret_keystring

Machine secret key returned on create. Treat as high-privilege — do not log.

created_atinteger

Unix timestamp in milliseconds when the machine was created.

updated_atinteger

Unix timestamp in milliseconds when the machine was last updated.

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/machines/{machine_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "machine_id": "mch_2abc123"
}

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

Example responses1 example

200Clerk machine metadata by id.

machine.json

{
  "machine": {
    "id": "mch_2abc123",
    "name": "billing-service",
    "instance_id": "ins_2abc123",
    "default_token_ttl": 3600,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/oauth-applications/{oauth_application_id}

https://api.vee3.io/v1/clerk/oauth-applications/{oauth_application_id}

3 tokens

Retrieve one OAuth application by id from a connected Clerk application.

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_oauth_application

Parameters2 fields

clerk_instance_idstringOptional

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

oauth_application_idstringRequired

Clerk OAuth application id (oa_...) to retrieve, update, or delete.

Response19 fields

oauth_applicationobject

18 fields

Clerk OAuth application summary.

idstring

OAuth application id (oa_...).

namestring

OAuth application display name.

client_idstring

OAuth client id issued to authorized clients.

client_secretstring

OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.

client_image_urlstring

URL of the OAuth application logo when set.

client_uristring

Homepage URI for the OAuth client.

redirect_urisstring[]

Allowed redirect URIs for the OAuth authorization flow.

scopesstring

Space-delimited scopes granted by this OAuth application.

consent_screen_enabledboolean

Whether the consent screen is shown during authorization.

publicboolean

Whether this is a public OAuth client (PKCE-capable, no client secret).

pkce_requiredboolean

Whether PKCE is required for the authorization flow.

dynamically_registeredboolean

Whether the OAuth application was registered dynamically.

instance_idstring

Clerk instance id (ins_...) that owns this OAuth application.

authorize_urlstring

Authorization endpoint URL for this OAuth application.

token_fetch_urlstring

Token endpoint URL for exchanging authorization codes.

discovery_urlstring

OpenID Connect discovery document URL.

created_atinteger

Unix timestamp in milliseconds when the OAuth application was created.

updated_atinteger

Unix timestamp in milliseconds when the OAuth application was last updated.

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/oauth-applications/{oauth_application_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "oauth_application_id": "oa_2abc123"
}

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

Example responses1 example

200A Clerk OAuth application.

oauth_application.json

{
  "oauth_application": {
    "id": "oa_2abc123",
    "name": "My OAuth App",
    "client_id": "client_2abc123",
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "scopes": "profile email",
    "public": false,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/organizations/{organization_id}

https://api.vee3.io/v1/clerk/organizations/{organization_id}

3 tokens

Retrieve a single organization from a connected Clerk application.

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_organization

Parameters2 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

Response6 fields

organizationobject

5 fields

Clerk organization details.

idstring

Clerk organization id (org_...).

namestring

Organization display name.

slugstring

URL-friendly organization slug, if set.

members_countinteger

Current number of members in the organization.

created_atinteger

Unix timestamp in milliseconds when the organization was created.

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/organizations/{organization_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789"
}

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

Example responses1 example

200A single Clerk organization.

organization_detail.json

{
  "organization": {
    "id": "org_2abc123",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "members_count": 12,
    "created_at": 1710000000000
  }
}

GET/v1/clerk/organizations/{organization_id}/billing/credit-balance

https://api.vee3.io/v1/clerk/organizations/{organization_id}/billing/credit-balance

3 tokens

Retrieve the billing credit balance for a Clerk organization.

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_organization_billing_credit_balance

Parameters2 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

Response3 fields

credit_balanceobject

2 fields

Organization billing credit balance summary.

balance_amountinteger

Credit balance amount in cents.

currencystring

ISO currency code for the credit balance.

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/organizations/{organization_id}/billing/credit-balance"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789"
}

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

Example responses1 example

200Billing credit balance for a Clerk organization.

organization_credit_balance.json

{
  "credit_balance": {
    "balance_amount": 5000,
    "currency": "usd"
  }
}

GET/v1/clerk/organizations/{organization_id}/billing/subscription

https://api.vee3.io/v1/clerk/organizations/{organization_id}/billing/subscription

3 tokens

Retrieve the billing subscription for a Clerk organization.

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_organization_billing_subscription

Parameters2 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

Response21 fields

subscriptionobject

20 fields

Organization billing subscription summary.

idstring

Clerk billing subscription id.

statusstring

Subscription status.

payer_idstring

Payer id (user_... or org_...) for the subscription.

instance_idstring

Clerk instance id for the subscription.

active_atinteger

Unix timestamp in milliseconds when the subscription became active.

past_due_atinteger

Unix timestamp in milliseconds when the subscription became past due.

created_atinteger

Unix timestamp in milliseconds when the subscription was created.

updated_atinteger

Unix timestamp in milliseconds when the subscription was last updated.

subscription_itemsarrayitems

11 fields

Subscription items on this subscription.

idstring

Clerk billing subscription item id.

statusstring

Subscription item status.

plan_idstring

Billing plan id for the subscription item.

price_idstring

Billing price id for the subscription item.

payer_idstring

Payer id (user_... or org_...) for the subscription item.

is_free_trialboolean

Whether the subscription item is in a free trial.

period_startinteger

Unix timestamp in milliseconds when the current billing period started.

period_endinteger

Unix timestamp in milliseconds when the current billing period ends.

canceled_atinteger

Unix timestamp in milliseconds when cancellation was requested.

ended_atinteger

Unix timestamp in milliseconds when the subscription item ended.

past_due_atinteger

Unix timestamp in milliseconds when the subscription item became past due.

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/organizations/{organization_id}/billing/subscription"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789"
}

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

Example responses1 example

200Billing subscription for a Clerk organization.

organization_billing_subscription.json

{
  "subscription": {
    "id": "sub_2abc123",
    "status": "active",
    "payer_id": "org_2abc123",
    "instance_id": "ins_2abc123",
    "active_at": 1710000000000,
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "subscription_items": [
      {
        "id": "si_2abc123",
        "status": "active",
        "plan_id": "plan_2abc123",
        "price_id": "price_2abc123",
        "payer_id": "user_2abc123",
        "is_free_trial": false,
        "period_start": 1710000000000,
        "period_end": 1712592000000
      }
    ]
  }
}

GET/v1/clerk/organizations/{organization_id}/invitations/{invitation_id}

https://api.vee3.io/v1/clerk/organizations/{organization_id}/invitations/{invitation_id}

3 tokens

Retrieve a single Clerk organization invitation by id.

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_organization_invitation

Parameters3 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

invitation_idstringRequired

Clerk organization invitation id (orginv_...).

Response6 fields

invitationobject

5 fields

Requested organization invitation summary.

idstring

Clerk organization invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

rolestring

Role assigned to the invitee (e.g. org:admin, org:member).

statusstring

Invitation status: pending, accepted, or revoked.

organization_idstring

Clerk organization id (org_...) that owns this invitation.

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/organizations/{organization_id}/invitations/{invitation_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789",
    "invitation_id": "inv_2abc123"
}

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

Example responses1 example

200Organization invitation retrieved by id.

invitation_found.json

{
  "invitation": {
    "id": "inv_2abc123",
    "email_address": "ada@example.com",
    "role": "org:member",
    "status": "pending",
    "organization_id": "org_2xyz456"
  }
}

GET/v1/clerk/organization-permissions/{permission_id}

https://api.vee3.io/v1/clerk/organization-permissions/{permission_id}

3 tokens

Retrieve an organization permission by id from a connected Clerk application.

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_organization_permission

Parameters2 fields

clerk_instance_idstringOptional

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

permission_idstringRequired

Clerk organization permission id to retrieve, update, delete, or assign to a role.

Response8 fields

organization_permissionobject

7 fields

Organization permission summary.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

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/organization-permissions/{permission_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "permission_id": "orgperm_2abc123"
}

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

Example responses1 example

200An organization permission.

organization_permission.json

{
  "organization_permission": {
    "id": "orgperm_2abc123",
    "name": "Manage billing",
    "key": "org:sys_billing:manage",
    "description": "Manage organization billing",
    "type": "system",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/organization-roles/{role_id}

https://api.vee3.io/v1/clerk/organization-roles/{role_id}

3 tokens

Retrieve an organization role by id from a connected Clerk application.

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_organization_role

Parameters2 fields

clerk_instance_idstringOptional

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

role_idstringRequired

Clerk organization role id to retrieve, update, delete, or assign permissions to.

Response16 fields

organization_roleobject

15 fields

Organization role summary.

idstring

Clerk organization role id.

namestring

Role display name.

keystring

Role key used in memberships.

descriptionstring

Role description.

is_creator_eligibleboolean

Whether this role may be assigned as organization creator.

permissionsarrayitems

7 fields

Permissions assigned to this role.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

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/organization-roles/{role_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "role_id": "orgrole_2abc123"
}

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

Example responses1 example

200An organization role.

organization_role.json

{
  "organization_role": {
    "id": "orgrl_2abc123",
    "name": "Admin",
    "key": "org:admin",
    "description": "Organization administrator",
    "is_creator_eligible": true,
    "permissions": [
      {
        "id": "orgperm_2abc123",
        "name": "Manage billing",
        "key": "org:sys_billing:manage",
        "description": "Manage organization billing",
        "type": "system",
        "created_at": 1710000000000,
        "updated_at": 1710000000000
      }
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/phone-numbers/{phone_number_id}

https://api.vee3.io/v1/clerk/phone-numbers/{phone_number_id}

3 tokens

Retrieve a Clerk phone number by id.

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_phone_number

Parameters2 fields

clerk_instance_idstringOptional

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

phone_number_idstringRequired

Clerk phone number id (idn_... or phn_...) to retrieve or modify.

Response5 fields

idstring

Clerk phone number id.

phone_numberstring

Phone number in E.164 format.

verifiedboolean

Whether the phone number is verified.

reserved_for_second_factorboolean

Whether the phone number is reserved for multi-factor authentication.

default_second_factorboolean

Whether this is the user's default second factor.

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/phone-numbers/{phone_number_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "phone_number_id": "phn_2abc123"
}

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

Example responses1 example

200Clerk phone number retrieved by id.

phone_number_found.json

{
  "id": "idn_2abc123",
  "phone_number": "+15551234567",
  "verified": true,
  "reserved_for_second_factor": false,
  "default_second_factor": false
}

GET/v1/clerk/redirect-urls/{redirect_url_id}

https://api.vee3.io/v1/clerk/redirect-urls/{redirect_url_id}

3 tokens

Retrieve an allowed redirect URL by id from 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_redirect_url

Parameters2 fields

clerk_instance_idstringOptional

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

redirect_url_idstringRequired

Clerk redirect URL id to retrieve or delete.

Response6 fields

redirect_urlobject

5 fields

Clerk redirect URL from the Backend API.

objectstring

Clerk object type for the redirect URL.

idstring

Clerk redirect URL id.

urlstring

Allowed redirect URL value.

created_atinteger

Unix timestamp in milliseconds when the redirect URL was created.

updated_atinteger

Unix timestamp in milliseconds when the redirect URL was last updated.

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/redirect-urls/{redirect_url_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "redirect_url_id": "ru_2abc123"
}

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

Example responses1 example

200Single allowed redirect URL.

redirect_url.json

{
  "redirect_url": {
    "object": "redirect_url",
    "id": "reurl_2abc123",
    "url": "https://example.com/dashboard",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/role-sets/{role_set_id}

https://api.vee3.io/v1/clerk/role-sets/{role_set_id}

3 tokens

Retrieve a role set by id from a connected Clerk application.

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_role_set

Parameters2 fields

clerk_instance_idstringOptional

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

role_set_idstringRequired

Clerk role set id or key to retrieve, update, or modify.

Response35 fields

role_setobject

34 fields

Role set summary.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems

8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject

8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject

8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

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/role-sets/{role_set_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "role_set_id": "orgroleset_2abc123"
}

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

Example responses1 example

200A role set.

role_set.json

{
  "role_set": {
    "id": "rs_2abc123",
    "name": "Default",
    "key": "default",
    "description": "Default organization roles",
    "roles": [
      {
        "id": "orgrl_2member",
        "name": "Member",
        "key": "org:member",
        "description": "Organization member",
        "created_at": 1710000000000,
        "updated_at": 1710000000000,
        "members_count": 42,
        "has_members": true
      }
    ],
    "default_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "creator_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "type": "default",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

GET/v1/clerk/sessions/{session_id}

https://api.vee3.io/v1/clerk/sessions/{session_id}

3 tokens

Retrieve a single session from a connected Clerk application.

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_session

Parameters2 fields

clerk_instance_idstringOptional

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

session_idstringRequired

Clerk session id (sess_...) to retrieve or modify.

Response8 fields

idstring

Clerk session id (sess_...).

user_idstring

Clerk user id (user_...) that owns this session.

statusstring

Current status of the session.

last_active_atinteger

Unix timestamp in milliseconds of the last activity on this session.

expire_atinteger

Unix timestamp in milliseconds when this session expires.

client_idstring

Clerk client id associated with this session.

created_atinteger

Unix timestamp in milliseconds when the session was created.

updated_atinteger

Unix timestamp in milliseconds when the session was last updated.

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/sessions/{session_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "session_id": "sess_2abc123"
}

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

Example responses1 example

200Session detail from a connected Clerk application.

session_detail.json

{
  "id": "sess_2abc123",
  "user_id": "user_2abc123",
  "status": "active",
  "last_active_at": 1710000000000,
  "expire_at": 1710086400000,
  "client_id": "client_2abc123",
  "created_at": 1709913600000,
  "updated_at": 1710000000000
}

GET/v1/clerk/sign-ups/{sign_up_id}

https://api.vee3.io/v1/clerk/sign-ups/{sign_up_id}

3 tokens

Retrieve an in-progress sign-up from a connected Clerk application.

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_sign_up

Parameters2 fields

clerk_instance_idstringOptional

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

sign_up_idstringRequired

Clerk sign-up id (su_...) to retrieve or update.

Response12 fields

idstring

Clerk sign-up id (su_...).

statusstring

Sign-up status: "missing_requirements", "complete", or "abandoned".

email_addressstring

Email address associated with the in-progress sign-up.

phone_numberstring

Phone number associated with the in-progress sign-up.

usernamestring

Username associated with the in-progress sign-up.

first_namestring

First name collected during sign-up.

last_namestring

Last name collected during sign-up.

missing_fieldsstring[]

Fields still required before the sign-up can complete.

unverified_fieldsstring[]

Fields that still need verification.

created_user_idstring

Clerk user id created when the sign-up completed.

created_session_idstring

Clerk session id created when the sign-up completed.

abandon_atinteger

Unix timestamp in milliseconds when the sign-up will be abandoned.

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/sign-ups/{sign_up_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "sign_up_id": "sign_up_2abc123"
}

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

Example responses1 example

200In-progress sign-up from a connected Clerk application.

sign_up_detail.json

{
  "id": "su_2abc123",
  "status": "missing_requirements",
  "email_address": "ada@example.com",
  "phone_number": null,
  "username": null,
  "first_name": "Ada",
  "last_name": "Lovelace",
  "missing_fields": [
    "password"
  ],
  "unverified_fields": [],
  "created_user_id": null,
  "created_session_id": null,
  "abandon_at": 1710086400000
}

GET/v1/clerk/users/{user_id}/billing/credit-balance

https://api.vee3.io/v1/clerk/users/{user_id}/billing/credit-balance

3 tokens

Retrieve the billing credit balance for a Clerk user.

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_user_billing_credit_balance

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

Response3 fields

credit_balanceobject

2 fields

User billing credit balance summary.

balance_amountinteger

Credit balance amount in cents.

currencystring

ISO currency code for the credit balance.

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/users/{user_id}/billing/credit-balance"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123"
}

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

Example responses1 example

200Billing credit balance for a Clerk user.

user_credit_balance.json

{
  "credit_balance": {
    "balance_amount": 5000,
    "currency": "usd"
  }
}

GET/v1/clerk/users/{user_id}/billing/subscription

https://api.vee3.io/v1/clerk/users/{user_id}/billing/subscription

3 tokens

Retrieve the billing subscription for a Clerk user.

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_user_billing_subscription

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

Response21 fields

subscriptionobject

20 fields

User billing subscription summary.

idstring

Clerk billing subscription id.

statusstring

Subscription status.

payer_idstring

Payer id (user_... or org_...) for the subscription.

instance_idstring

Clerk instance id for the subscription.

active_atinteger

Unix timestamp in milliseconds when the subscription became active.

past_due_atinteger

Unix timestamp in milliseconds when the subscription became past due.

created_atinteger

Unix timestamp in milliseconds when the subscription was created.

updated_atinteger

Unix timestamp in milliseconds when the subscription was last updated.

subscription_itemsarrayitems

11 fields

Subscription items on this subscription.

idstring

Clerk billing subscription item id.

statusstring

Subscription item status.

plan_idstring

Billing plan id for the subscription item.

price_idstring

Billing price id for the subscription item.

payer_idstring

Payer id (user_... or org_...) for the subscription item.

is_free_trialboolean

Whether the subscription item is in a free trial.

period_startinteger

Unix timestamp in milliseconds when the current billing period started.

period_endinteger

Unix timestamp in milliseconds when the current billing period ends.

canceled_atinteger

Unix timestamp in milliseconds when cancellation was requested.

ended_atinteger

Unix timestamp in milliseconds when the subscription item ended.

past_due_atinteger

Unix timestamp in milliseconds when the subscription item became past due.

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/users/{user_id}/billing/subscription"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123"
}

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

Example responses1 example

200Billing subscription for a Clerk user.

user_billing_subscription.json

{
  "subscription": {
    "id": "sub_2abc123",
    "status": "active",
    "payer_id": "user_2abc123",
    "instance_id": "ins_2abc123",
    "active_at": 1710000000000,
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "subscription_items": [
      {
        "id": "si_2abc123",
        "status": "active",
        "plan_id": "plan_2abc123",
        "price_id": "price_2abc123",
        "payer_id": "user_2abc123",
        "is_free_trial": false,
        "period_start": 1710000000000,
        "period_end": 1712592000000
      }
    ]
  }
}

POST/v1/clerk/email-addresses/{email_address_id}/attempt-verification

https://api.vee3.io/v1/clerk/email-addresses/{email_address_id}/attempt-verification

5 tokens

Submit a verification code for a Clerk email address.

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

Parameters4 fields

clerk_instance_idstringOptional

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

email_address_idstringRequired

Clerk email address id (idn_...) to retrieve or modify.

verification_idstringRequired

Verification id from prepare-clerk-email-address-verification.

codestringRequired

Verification code sent to the email address.

Response6 fields

verificationobject

5 fields

Verification object with updated status from the Clerk Backend API.

idstring

Verification id returned by prepare_verification.

statusstring

Verification status (verified, unverified, expired, or failed).

strategystring

Verification strategy (e.g. phone_code).

attemptsinteger

Number of verification attempts made.

expire_atinteger

Unix timestamp in milliseconds when the verification code expires.

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/email-addresses/{email_address_id}/attempt-verification"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "email_address_id": "idn_2abc123",
    "verification_id": "ver_2abc123",
    "code": "424242"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk email address after successful verification.

verification_attempted.json

{
  "verification": {
    "id": "ver_2abc123",
    "status": "verified",
    "strategy": "email_code",
    "attempts": 1,
    "expire_at": 1710003600000
  }
}

POST/v1/clerk/phone-numbers/{phone_number_id}/attempt-verification

https://api.vee3.io/v1/clerk/phone-numbers/{phone_number_id}/attempt-verification

5 tokens

Verify an SMS code sent to a Clerk phone number.

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

Parameters4 fields

clerk_instance_idstringOptional

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

phone_number_idstringRequired

Clerk phone number id (idn_... or phn_...) to retrieve or modify.

verification_idstringRequired

Verification id from prepare-clerk-phone-number-verification.

codestringRequired

SMS verification code entered by the user.

Response6 fields

verificationobject

5 fields

Verification object with updated status from the Clerk Backend API.

idstring

Verification id returned by prepare_verification.

statusstring

Verification status (verified, unverified, expired, or failed).

strategystring

Verification strategy (e.g. phone_code).

attemptsinteger

Number of verification attempts made.

expire_atinteger

Unix timestamp in milliseconds when the verification code expires.

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/phone-numbers/{phone_number_id}/attempt-verification"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "phone_number_id": "phn_2abc123",
    "verification_id": "ver_2abc123",
    "code": "424242"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Verification code checked.

verification_attempted.json

{
  "verification": {
    "id": "ver_2abc123",
    "status": "verified",
    "strategy": "phone_code",
    "attempts": 0,
    "expire_at": 1710003600000
  }
}

POST/v1/clerk/users/{user_id}/ban

https://api.vee3.io/v1/clerk/users/{user_id}/ban

5 tokens

Ban a user from signing in to a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to ban.

Response6 fields

userobject

5 fields

Updated Clerk user object after the ban.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/ban"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after being banned.

banned_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

GET/v1/clerk/api-keys/{api_key_id}/secret

https://api.vee3.io/v1/clerk/api-keys/{api_key_id}/secret

5 tokens

Reveal the secret for an API key in a connected Clerk application.

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_api_key_secret

Parameters2 fields

clerk_instance_idstringOptional

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

api_key_idstringRequired

Clerk API key id (ak_...) to retrieve, update, delete, or revoke.

Response1 field

secretstring

API key secret value. Treat as high-privilege — do not log.

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/api-keys/{api_key_id}/secret"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "api_key_id": "ak_2abc123"
}

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

Example responses1 example

200Revealed Clerk API key secret.

api_key_secret.json

{
  "secret": "ak_live_example_secret"
}

GET/v1/clerk/machines/{machine_id}/secret-key

https://api.vee3.io/v1/clerk/machines/{machine_id}/secret-key

5 tokens

Retrieve the secret key for a machine in 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_machine_secret_key

Parameters2 fields

clerk_instance_idstringOptional

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

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

Response3 fields

machine_secret_keyobject

2 fields

Machine secret key payload from the Backend API.

objectstring

Object type (machine_secret_key).

secretstring

Machine secret key. Treat as high-privilege — do not log.

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/machines/{machine_id}/secret-key"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "machine_id": "mch_2abc123"
}

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

Example responses1 example

200Secret key for a Clerk machine.

machine_secret_key.json

{
  "machine_secret_key": {
    "object": "machine_secret_key",
    "secret": "msk_test_secret_value"
  }
}

GET/v1/clerk/organization-domains

https://api.vee3.io/v1/clerk/organization-domains

5 tokens

List organization domains across all organizations in a 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.list_all_organization_domains

Parameters7 fields

clerk_instance_idstringOptional

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

organization_idstringOptional

Filter domains to a specific Clerk organization id (org_...).

verifiedstringOptional

Filter by verification status: "true" or "false".

enrollment_modestringOptional

Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

querystringOptional

Search domains by name or organization id. Values starting with org_ match organization id exactly; otherwise performs a case-insensitive partial match on the domain name.

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

Response13 fields

domainsarrayitems

11 fields

Organization domains returned for the requested page.

idstring

Clerk organization domain id (dmn_...).

namestring

Domain name (for example example.com).

organization_idstring

Clerk organization id (org_...) that owns this domain.

enrollment_modestring

Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

affiliation_email_addressstring

Affiliation email address for the domain, when set.

ownership_verification_statusstring

DNS ownership verification status (unverified, verified, failed, or expired).

affiliation_verification_statusstring

Affiliation verification status (unverified, verified, failed, or expired).

total_pending_invitationsinteger

Number of pending invitations associated with this domain.

total_pending_suggestionsinteger

Number of pending membership suggestions associated with this domain.

created_atinteger

Unix timestamp in milliseconds when the domain was created.

updated_atinteger

Unix timestamp in milliseconds when the domain was last updated.

total_countinteger

Total number of domains matching the filter.

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/organization-domains"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789",
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200First page of organization domains across all organizations.

all_domains_page.json

{
  "domains": [
    {
      "id": "dmn_2abc123",
      "name": "example.com",
      "organization_id": "org_2xyz456",
      "enrollment_mode": "automatic_invitation",
      "affiliation_email_address": null,
      "ownership_verification_status": "verified",
      "affiliation_verification_status": "verified",
      "total_pending_invitations": 0,
      "total_pending_suggestions": 0,
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/organization-invitations

https://api.vee3.io/v1/clerk/organization-invitations

5 tokens

List organization invitations across all organizations in a 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.list_all_organization_invitations

Parameters4 fields

clerk_instance_idstringOptional

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

statusstringOptional

Filter by invitation status: pending, accepted, revoked, or expired.

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

Response7 fields

invitationsarrayitems

5 fields

Invitations returned for the requested page.

idstring

Clerk organization invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

rolestring

Role assigned to the invitee (e.g. org:admin, org:member).

statusstring

Invitation status: pending, accepted, or revoked.

organization_idstring

Clerk organization id (org_...) that owns this invitation.

total_countinteger

Total number of invitations matching the filter.

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/organization-invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "status": "example"
}

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

Example responses1 example

200First page of organization invitations across all organizations.

all_invitations_page.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "email_address": "ada@example.com",
      "role": "org:member",
      "status": "pending",
      "organization_id": "org_2xyz456"
    }
  ],
  "total_count": 1
}

GET/v1/clerk/allowlist-identifiers

https://api.vee3.io/v1/clerk/allowlist-identifiers

5 tokens

List allowlisted emails, phones, and domains in 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.list_allowlist_identifiers

Parameters3 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of identifiers to return (1–500).

Default: 10

offsetintegerOptional

Number of identifiers to skip before returning results.

Default: 0

Response8 fields

identifiersarrayitems

6 fields

Allowlist identifiers returned for the requested page.

idstring

Allowlist identifier id (alid_...).

identifierstring

Allowlisted email, phone, domain pattern, or Web3 wallet address.

identifier_typestring

Type of identifier: "email_address", "phone_number", or "web3_wallet".

invitation_idstring

Clerk invitation id (inv_...) when the entry was created from an invitation.

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

total_countinteger

Total number of allowlist identifiers for the instance.

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/allowlist-identifiers"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200First page of allowlist identifiers.

allowlist_page.json

{
  "identifiers": [
    {
      "id": "alid_2abc123",
      "identifier": "ada@example.com",
      "identifier_type": "email_address",
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/billing/prices

https://api.vee3.io/v1/clerk/billing/prices

5 tokens

List billing prices in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

paginatedbooleanOptional

Whether to return paginated results with total_count.

limitintegerOptional

Maximum number of billing prices to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of billing prices to skip before returning results.

Default: 0 · min 0

plan_idstringOptional

Filter by billing plan id.

Response10 fields

billing_pricesarrayitems

8 fields

Billing prices in the connected Clerk application.

idstring

Clerk billing price id.

plan_idstring

Billing plan id this price belongs to.

currencystring

ISO currency code (for example usd).

amountinteger

Price amount in cents.

annual_monthly_amountinteger

Equivalent monthly amount in cents when billed annually.

descriptionstring

Price description.

is_defaultboolean

Whether this is the default price for the plan.

created_atinteger

Unix timestamp in milliseconds when the price was created.

total_countinteger

Total number of billing prices matching the query.

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/billing/prices"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "paginated": False
}

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

Example responses1 example

200Billing prices from a connected Clerk application.

billing_price_list.json

{
  "billing_prices": [
    {
      "id": "price_2abc123",
      "plan_id": "plan_2abc123",
      "currency": "usd",
      "amount": 2000,
      "annual_monthly_amount": 1500,
      "description": "Monthly Pro",
      "is_default": true,
      "created_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/billing/statements/{statement_id}/payment-attempts

https://api.vee3.io/v1/clerk/billing/statements/{statement_id}/payment-attempts

5 tokens

List payment attempts for a billing statement.

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

Parameters5 fields

clerk_instance_idstringOptional

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

paginatedbooleanOptional

Whether to return paginated results with total_count.

limitintegerOptional

Maximum number of payment attempts to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of payment attempts to skip before returning results.

Default: 0 · min 0

statement_idstringRequired

Clerk billing statement id.

Response7 fields

payment_attemptsarrayitems

5 fields

Payment attempts for the billing statement.

idstring

Clerk billing payment attempt id.

statusstring

Payment attempt status.

timestampinteger

Unix timestamp in milliseconds for the payment attempt.

amountinteger

Payment attempt amount in cents.

currencystring

ISO currency code for the payment attempt.

total_countinteger

Total number of payment attempts for the statement.

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/billing/statements/{statement_id}/payment-attempts"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "statement_id": "stmt_2abc123"
}

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

Example responses1 example

200Payment attempts for a billing statement.

payment_attempt_list.json

{
  "payment_attempts": [
    {
      "id": "pa_2abc123",
      "status": "succeeded",
      "timestamp": 1710000000000,
      "amount": 2000,
      "currency": "usd"
    }
  ],
  "total_count": 1
}

GET/v1/clerk/billing/statements

https://api.vee3.io/v1/clerk/billing/statements

5 tokens

List billing statements in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

paginatedbooleanOptional

Whether to return paginated results with total_count.

limitintegerOptional

Maximum number of billing statements to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of billing statements to skip before returning results.

Default: 0 · min 0

Response8 fields

billing_statementsarrayitems

6 fields

Billing statements in the connected Clerk application.

idstring

Clerk billing statement id.

statusstring

Statement status.

timestampinteger

Unix timestamp in milliseconds for the statement.

payer_idstring

Payer id (user_... or org_...) for the statement.

grand_total_amountinteger

Grand total amount in cents.

grand_total_currencystring

ISO currency code for the grand total.

total_countinteger

Total number of billing statements matching the query.

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/billing/statements"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "paginated": False
}

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

Example responses1 example

200Billing statements from a connected Clerk application.

billing_statement_list.json

{
  "billing_statements": [
    {
      "id": "stmt_2abc123",
      "status": "paid",
      "timestamp": 1710000000000,
      "payer_id": "user_2abc123",
      "grand_total_amount": 2000,
      "grand_total_currency": "usd"
    }
  ],
  "total_count": 1
}

GET/v1/clerk/billing/subscription-items

https://api.vee3.io/v1/clerk/billing/subscription-items

5 tokens

List billing subscription items in a connected Clerk application.

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

Parameters9 fields

clerk_instance_idstringOptional

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

paginatedbooleanOptional

Whether to return paginated results with total_count.

limitintegerOptional

Maximum number of subscription items to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of subscription items to skip before returning results.

Default: 0 · min 0

statusstringOptional

Filter by subscription item status.

payer_type"user" | "org"Optional

Filter by payer type: "user" or "org".

plan_idstringOptional

Filter by billing plan id.

include_freebooleanOptional

When true, include free subscription items.

querystringOptional

Search query to filter subscription items.

Response13 fields

subscription_itemsarrayitems

11 fields

Billing subscription items matching the query.

idstring

Clerk billing subscription item id.

statusstring

Subscription item status.

plan_idstring

Billing plan id for the subscription item.

price_idstring

Billing price id for the subscription item.

payer_idstring

Payer id (user_... or org_...) for the subscription item.

is_free_trialboolean

Whether the subscription item is in a free trial.

period_startinteger

Unix timestamp in milliseconds when the current billing period started.

period_endinteger

Unix timestamp in milliseconds when the current billing period ends.

canceled_atinteger

Unix timestamp in milliseconds when cancellation was requested.

ended_atinteger

Unix timestamp in milliseconds when the subscription item ended.

past_due_atinteger

Unix timestamp in milliseconds when the subscription item became past due.

total_countinteger

Total number of subscription items matching the query.

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/billing/subscription-items"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200Billing subscription items from a connected Clerk application.

subscription_item_list.json

{
  "subscription_items": [
    {
      "id": "si_2abc123",
      "status": "active",
      "plan_id": "plan_2abc123",
      "price_id": "price_2abc123",
      "payer_id": "user_2abc123",
      "is_free_trial": false,
      "period_start": 1710000000000,
      "period_end": 1712592000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/blocklist-identifiers

https://api.vee3.io/v1/clerk/blocklist-identifiers

5 tokens

List blocklisted emails, phones, and domains in 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.list_blocklist_identifiers

Parameters3 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of identifiers to return (1–500).

Default: 10

offsetintegerOptional

Number of identifiers to skip before returning results.

Default: 0

Response7 fields

identifiersarrayitems

5 fields

Blocklist identifiers returned for the requested page.

idstring

Blocklist identifier id (blid_...).

identifierstring

Blocklisted email, domain, phone, or Web3 wallet address.

identifier_typestring

Type of identifier: "email_address", "phone_number", or "web3_wallet".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

total_countinteger

Total number of blocklist identifiers for the instance.

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/blocklist-identifiers"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200First page of blocklist identifiers.

blocklist_page.json

{
  "identifiers": [
    {
      "id": "blid_2abc123",
      "identifier": "spam@example.com",
      "identifier_type": "email_address",
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/domains

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

5 tokens

List custom domains configured 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.list_domains

Parameters1 field

clerk_instance_idstringOptional

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

Response14 fields

domainsarrayitems

12 fields

Custom domains configured for the connected Clerk instance.

objectstring

Clerk object type for the domain.

idstring

Clerk domain id.

namestring

Domain hostname.

is_satelliteboolean

Whether this is a satellite domain.

frontend_api_urlstring

Frontend API URL for the domain.

accounts_portal_urlstring

Accounts portal URL for the domain.

proxy_urlstring

Proxy URL when using a satellite domain behind a reverse proxy.

development_originstring

Development origin associated with the domain.

cname_targetsarrayitems

3 fields

CNAME records required to verify the domain.

hoststring

DNS host label for the CNAME record.

valuestring

DNS target value for the CNAME record.

requiredboolean

Whether this CNAME record is required for domain verification.

total_countinteger

Total number of domains.

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

200Custom domains for a connected Clerk instance.

domain_list.json

{
  "domains": [
    {
      "object": "domain",
      "id": "dmn_2abc123",
      "name": "auth.example.com",
      "is_satellite": false,
      "frontend_api_url": "https://clerk.example.com",
      "accounts_portal_url": "https://accounts.example.com",
      "proxy_url": null,
      "development_origin": null,
      "cname_targets": [
        {
          "host": "clerk",
          "value": "frontend-api.clerk.services",
          "required": true
        }
      ]
    }
  ],
  "total_count": 1
}

GET/v1/clerk/enterprise-connections/{connection_id}/test-runs

https://api.vee3.io/v1/clerk/enterprise-connections/{connection_id}/test-runs

5 tokens

List SSO debug test runs for an enterprise connection.

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

Parameters5 fields

clerk_instance_idstringOptional

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

connection_idstringRequired

Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

statusarrayOptional

Filter by test run status: "pending", "success", or "failed".

Response16 fields

test_runsarrayitems

14 fields

Enterprise connection SSO test runs.

idstring

Enterprise connection test run id.

statusstring

Test run status: "pending", "success", or "failed".

connection_typestring

Connection type tested: "saml" or "oauth".

created_atinteger

Unix timestamp in milliseconds when the test run was created.

parsed_user_infoobject

4 fields

User attributes parsed from the IdP response.

email_addressstring

Email address parsed from the IdP response.

first_namestring

First name parsed from the IdP response.

last_namestring

Last name parsed from the IdP response.

user_idstring

User id parsed from the IdP response.

logsarrayitems

4 fields

Log entries captured during the test run.

levelstring

Log level (for example info, warn, or error).

messagestring

Log message text.

codestring

Optional machine-readable log code.

short_messagestring

Optional short log summary.

total_countinteger

Total number of test runs matching the query.

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/enterprise-connections/{connection_id}/test-runs"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "connection_id": "conn_2abc123"
}

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

Example responses1 example

200SSO test runs for an enterprise connection.

enterprise_connection_test_run_list.json

{
  "test_runs": [
    {
      "id": "ectr_2abc123",
      "status": "success",
      "connection_type": "saml",
      "created_at": 1710000000000,
      "parsed_user_info": {
        "email_address": "user@acme.com",
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "logs": [
        {
          "level": "info",
          "message": "SAML response validated successfully."
        }
      ]
    }
  ],
  "total_count": 1
}

GET/v1/clerk/enterprise-connections

https://api.vee3.io/v1/clerk/enterprise-connections

5 tokens

List enterprise SSO connections in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

organization_idstringOptional

Filter connections linked to this Clerk organization id (org_...).

activebooleanOptional

Filter by active status. Omit to return all connections.

Response37 fields

enterprise_connectionsarrayitems

35 fields

Enterprise SSO connections in the connected Clerk application.

idstring

Enterprise connection id.

namestring

Display name for the connection.

providerstring

Identity provider key (for example saml_custom or oidc_custom).

activeboolean

Whether the connection is active.

domainsstring[]

Email domains that may use this connection.

created_atinteger

Unix timestamp in milliseconds when the connection was created.

updated_atinteger

Unix timestamp in milliseconds when the connection was last updated.

logo_public_urlstring

Public logo URL for the connection when available.

organization_idstring

Linked Clerk organization id (org_...) when the connection is org-scoped.

sync_user_attributesboolean

Whether user attributes sync on each sign-in.

disable_additional_identificationsboolean

Whether users may add additional identifications with this connection.

allow_organization_account_linkingboolean

Whether account linking via organization membership is supported.

custom_attributesarrayitems

5 fields

Custom attribute mappings from the IdP to user metadata.

namestring

Display name for the custom attribute.

keystring

Metadata key used to store the attribute on the user.

sso_pathstring

Path to extract the value from SSO claims.

scim_pathstring

GJSON path to extract the value from SCIM resources.

multi_valuedboolean

Whether the attribute supports multiple values.

saml_connectionobject

9 fields

SAML configuration when the connection uses SAML.

idstring

SAML connection id when the connection uses SAML.

namestring

SAML connection display name.

idp_entity_idstring

Identity Provider entity id.

idp_sso_urlstring

Identity Provider Single Sign-On URL.

acs_urlstring

Assertion Consumer Service URL.

sp_entity_idstring

Service Provider entity id (Clerk).

activeboolean

Whether the SAML connection is active.

allow_idp_initiatedboolean

Whether IdP-initiated SSO is allowed.

allow_subdomainsboolean

Whether email subdomains may use this connection.

oauth_configobject

6 fields

OIDC configuration when the connection uses OAuth.

idstring

OAuth config id when the connection uses OIDC.

namestring

Custom OIDC provider display name.

provider_keystring

OAuth provider key (for example oidc_custom).

client_idstring

OAuth client id.

discovery_urlstring

OIDC discovery URL.

requires_pkceboolean

Whether PKCE is required for this OAuth client.

total_countinteger

Total number of enterprise connections matching the query.

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/enterprise-connections"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789",
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200Enterprise SSO connections from a connected Clerk application.

enterprise_connection_list.json

{
  "enterprise_connections": [
    {
      "id": "entc_2abc123",
      "name": "Acme SAML",
      "provider": "saml_custom",
      "active": true,
      "domains": [
        "acme.com"
      ],
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "sync_user_attributes": true,
      "disable_additional_identifications": false,
      "allow_organization_account_linking": false,
      "saml_connection": {
        "id": "saml_2abc123",
        "name": "Acme SAML",
        "idp_entity_id": "https://idp.acme.com",
        "idp_sso_url": "https://idp.acme.com/sso",
        "acs_url": "https://clerk.example.com/v1/saml/acs",
        "sp_entity_id": "https://clerk.example.com",
        "active": true,
        "allow_idp_initiated": false,
        "allow_subdomains": false
      }
    }
  ],
  "total_count": 1
}

GET/v1/clerk/instance-organization-memberships

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

5 tokens

List all organization memberships across a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of organization memberships to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of organization memberships to skip before returning results.

Default: 0 · min 0

Response7 fields

membershipsarrayitems

5 fields

Organization memberships across the Clerk application.

idstring

Organization membership id.

organization_idstring

Clerk organization id (org_...).

rolestring

Member role within the organization (e.g. org:admin, org:member).

created_atinteger

Unix timestamp in milliseconds when the membership was created.

updated_atinteger

Unix timestamp in milliseconds when the membership was last updated.

total_countinteger

Total number of organization memberships in the Clerk application.

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-memberships"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200Organization memberships across a Clerk application.

instance_org_memberships.json

{
  "memberships": [
    {
      "id": "orgmem_2abc123",
      "organization_id": "org_2xyz789",
      "role": "org:admin",
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/m2m-tokens

https://api.vee3.io/v1/clerk/m2m-tokens

5 tokens

List opaque M2M tokens for a machine in 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.list_m2m_tokens

Parameters6 fields

clerk_instance_idstringOptional

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

subjectstringRequired

Machine id (mch_...) whose tokens to list.

revokedbooleanOptional

Include revoked tokens (default false).

expiredbooleanOptional

Include expired tokens (default false).

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

Response10 fields

m2m_tokensarrayitems

8 fields

M2M tokens for the requested page.

idstring

M2M token id (mt_...).

subjectstring

Machine id (mch_...) that created or owns the token.

tokenstring

M2M token secret when returned on creation. Treat as high-privilege — do not log.

revokedboolean

Whether the token has been revoked.

expiredboolean

Whether the token has expired.

expirationinteger

Unix timestamp in milliseconds when the token expires.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

total_countinteger

Total number of matching M2M tokens.

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/m2m-tokens"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "subject": "user_2abc123"
}

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

Example responses1 example

200First page of M2M tokens for a machine.

m2m_token_page.json

{
  "m2m_tokens": [
    {
      "id": "mt_f7f0ba8c3b4843ce7d85fcdd5e71853e",
      "subject": "mch_2abc123",
      "revoked": false,
      "expired": false,
      "expiration": 1710003600000,
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/machines

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

5 tokens

List machine-to-machine identities in 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.list_machines

Parameters5 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

querystringOptional

Filter by machine id (exact) or name (partial match).

order_bystringOptional

Sort by name or created_at; prefix with - for descending (default -created_at).

Response9 fields

machinesarrayitems

7 fields

Machines for the requested page.

idstring

Machine id (mch_...).

namestring

Machine display name.

instance_idstring

Clerk instance id (ins_...) that owns the machine.

default_token_ttlinteger

Default token lifetime in seconds for tokens created by this machine.

secret_keystring

Machine secret key returned on create. Treat as high-privilege — do not log.

created_atinteger

Unix timestamp in milliseconds when the machine was created.

updated_atinteger

Unix timestamp in milliseconds when the machine was last updated.

total_countinteger

Total number of machines in the instance.

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/machines"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200First page of Clerk machines.

machine_page.json

{
  "machines": [
    {
      "id": "mch_2abc123",
      "name": "billing-service",
      "instance_id": "ins_2abc123",
      "default_token_ttl": 3600,
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/oauth-applications

https://api.vee3.io/v1/clerk/oauth-applications

5 tokens

List OAuth applications in a connected Clerk application (Clerk as IdP).

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

Parameters1 field

clerk_instance_idstringOptional

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

Response20 fields

oauth_applicationsarrayitems

18 fields

OAuth applications in the connected Clerk application.

idstring

OAuth application id (oa_...).

namestring

OAuth application display name.

client_idstring

OAuth client id issued to authorized clients.

client_secretstring

OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.

client_image_urlstring

URL of the OAuth application logo when set.

client_uristring

Homepage URI for the OAuth client.

redirect_urisstring[]

Allowed redirect URIs for the OAuth authorization flow.

scopesstring

Space-delimited scopes granted by this OAuth application.

consent_screen_enabledboolean

Whether the consent screen is shown during authorization.

publicboolean

Whether this is a public OAuth client (PKCE-capable, no client secret).

pkce_requiredboolean

Whether PKCE is required for the authorization flow.

dynamically_registeredboolean

Whether the OAuth application was registered dynamically.

instance_idstring

Clerk instance id (ins_...) that owns this OAuth application.

authorize_urlstring

Authorization endpoint URL for this OAuth application.

token_fetch_urlstring

Token endpoint URL for exchanging authorization codes.

discovery_urlstring

OpenID Connect discovery document URL.

created_atinteger

Unix timestamp in milliseconds when the OAuth application was created.

updated_atinteger

Unix timestamp in milliseconds when the OAuth application was last updated.

total_countinteger

Total number of OAuth applications.

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/oauth-applications"
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

200OAuth applications from a connected Clerk application.

oauth_application_list.json

{
  "oauth_applications": [
    {
      "id": "oa_2abc123",
      "name": "My OAuth App",
      "client_id": "client_2abc123",
      "client_secret": null,
      "redirect_uris": [
        "https://example.com/callback"
      ],
      "scopes": "profile email",
      "public": false,
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/organizations/{organization_id}/domains

https://api.vee3.io/v1/clerk/organizations/{organization_id}/domains

5 tokens

List verified domains for a specific Clerk organization.

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

Parameters6 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

verifiedstringOptional

Filter by verification status: "true" or "false".

enrollment_modestringOptional

Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

Response13 fields

domainsarrayitems

11 fields

Organization domains returned for the requested page.

idstring

Clerk organization domain id (dmn_...).

namestring

Domain name (for example example.com).

organization_idstring

Clerk organization id (org_...) that owns this domain.

enrollment_modestring

Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

affiliation_email_addressstring

Affiliation email address for the domain, when set.

ownership_verification_statusstring

DNS ownership verification status (unverified, verified, failed, or expired).

affiliation_verification_statusstring

Affiliation verification status (unverified, verified, failed, or expired).

total_pending_invitationsinteger

Number of pending invitations associated with this domain.

total_pending_suggestionsinteger

Number of pending membership suggestions associated with this domain.

created_atinteger

Unix timestamp in milliseconds when the domain was created.

updated_atinteger

Unix timestamp in milliseconds when the domain was last updated.

total_countinteger

Total number of domains matching the filter.

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/organizations/{organization_id}/domains"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789"
}

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

Example responses1 example

200First page of domains for a Clerk organization.

organization_domains_page.json

{
  "domains": [
    {
      "id": "dmn_2abc123",
      "name": "example.com",
      "organization_id": "org_2xyz456",
      "enrollment_mode": "automatic_invitation",
      "affiliation_email_address": null,
      "ownership_verification_status": "verified",
      "affiliation_verification_status": "verified",
      "total_pending_invitations": 0,
      "total_pending_suggestions": 0,
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/organizations/{organization_id}/invitations

https://api.vee3.io/v1/clerk/organizations/{organization_id}/invitations

5 tokens

List invitations for a specific Clerk organization.

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

Parameters5 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

statusstringOptional

Filter by invitation status: pending, accepted, revoked, or expired.

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

Response7 fields

invitationsarrayitems

5 fields

Invitations returned for the requested page.

idstring

Clerk organization invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

rolestring

Role assigned to the invitee (e.g. org:admin, org:member).

statusstring

Invitation status: pending, accepted, or revoked.

organization_idstring

Clerk organization id (org_...) that owns this invitation.

total_countinteger

Total number of invitations matching the filter.

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/organizations/{organization_id}/invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "organization_id": "org_2xyz789"
}

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

Example responses1 example

200First page of invitations for a Clerk organization.

invitation_page.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "email_address": "ada@example.com",
      "role": "org:member",
      "status": "pending",
      "organization_id": "org_2xyz456"
    }
  ],
  "total_count": 1
}

GET/v1/clerk/organization-permissions

https://api.vee3.io/v1/clerk/organization-permissions

5 tokens

List organization permissions in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

querystringOptional

Search by name or key.

order_bystringOptional

Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.

Response9 fields

organization_permissionsarrayitems

7 fields

Organization permissions in the connected Clerk application.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

total_countinteger

Total number of organization permissions.

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/organization-permissions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200Organization permissions from a connected Clerk application.

organization_permission_list.json

{
  "organization_permissions": [
    {
      "id": "orgperm_2abc123",
      "name": "Manage billing",
      "key": "org:sys_billing:manage",
      "description": "Manage organization billing",
      "type": "system",
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/organization-roles

https://api.vee3.io/v1/clerk/organization-roles

5 tokens

List organization roles in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

querystringOptional

Search by name or key.

order_bystringOptional

Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.

Response17 fields

organization_rolesarrayitems

15 fields

Organization roles in the connected Clerk application.

idstring

Clerk organization role id.

namestring

Role display name.

keystring

Role key used in memberships.

descriptionstring

Role description.

is_creator_eligibleboolean

Whether this role may be assigned as organization creator.

permissionsarrayitems

7 fields

Permissions assigned to this role.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

total_countinteger

Total number of organization roles.

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/organization-roles"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200Organization roles from a connected Clerk application.

organization_role_list.json

{
  "organization_roles": [
    {
      "id": "orgrl_2abc123",
      "name": "Admin",
      "key": "org:admin",
      "description": "Organization administrator",
      "is_creator_eligible": true,
      "permissions": [
        {
          "id": "orgperm_2abc123",
          "name": "Manage billing",
          "key": "org:sys_billing:manage",
          "description": "Manage organization billing",
          "type": "system",
          "created_at": 1710000000000,
          "updated_at": 1710000000000
        }
      ],
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/redirect-urls

https://api.vee3.io/v1/clerk/redirect-urls

5 tokens

List allowed redirect URLs 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.list_redirect_urls

Parameters3 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of redirect URLs to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of redirect URLs to skip before returning results.

Default: 0 · min 0

Response7 fields

redirect_urlsarrayitems

5 fields

Allowed redirect URLs returned for the requested page.

objectstring

Clerk object type for the redirect URL.

idstring

Clerk redirect URL id.

urlstring

Allowed redirect URL value.

created_atinteger

Unix timestamp in milliseconds when the redirect URL was created.

updated_atinteger

Unix timestamp in milliseconds when the redirect URL was last updated.

total_countinteger

Total number of redirect URLs.

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/redirect-urls"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0
}

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

Example responses1 example

200Allowed redirect URLs for a connected Clerk instance.

redirect_url_list.json

{
  "redirect_urls": [
    {
      "object": "redirect_url",
      "id": "reurl_2abc123",
      "url": "https://example.com/dashboard",
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/role-sets

https://api.vee3.io/v1/clerk/role-sets

5 tokens

List role sets in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of results to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of results to skip before returning.

Default: 0 · min 0

querystringOptional

Search by name or key.

order_bystringOptional

Sort order with optional + or - prefix (for example -created_at or name). Defaults to -created_at.

Response36 fields

role_setsarrayitems

34 fields

Role sets in the connected Clerk application.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems

8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject

8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject

8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

total_countinteger

Total number of role sets.

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/role-sets"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200Role sets from a connected Clerk application.

role_set_list.json

{
  "role_sets": [
    {
      "id": "rs_2abc123",
      "name": "Default",
      "key": "default",
      "description": "Default organization roles",
      "roles": [
        {
          "id": "orgrl_2member",
          "name": "Member",
          "key": "org:member",
          "description": "Organization member",
          "created_at": 1710000000000,
          "updated_at": 1710000000000,
          "members_count": 42,
          "has_members": true
        }
      ],
      "default_role": {
        "id": "orgrl_2member",
        "name": "Member",
        "key": "org:member",
        "description": "Organization member",
        "created_at": 1710000000000,
        "updated_at": 1710000000000,
        "members_count": 42,
        "has_members": true
      },
      "creator_role": {
        "id": "orgrl_2member",
        "name": "Member",
        "key": "org:member",
        "description": "Organization member",
        "created_at": 1710000000000,
        "updated_at": 1710000000000,
        "members_count": 42,
        "has_members": true
      },
      "type": "default",
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/users/{user_id}/organization-invitations

https://api.vee3.io/v1/clerk/users/{user_id}/organization-invitations

5 tokens

List all pending organization invitations for a Clerk user.

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

Parameters4 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) whose invitations to list.

limitintegerOptional

Maximum number of organization invitations to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of organization invitations to skip before returning results.

Default: 0 · min 0

Response8 fields

invitationsarrayitems

6 fields

Organization invitations for the user.

idstring

Organization invitation id.

organization_idstring

Clerk organization id (org_...) the invitation is for.

email_addressstring

Email address the invitation was sent to.

rolestring

Role the invitee will receive upon accepting.

statusstring

Invitation status (pending, accepted, or revoked).

created_atinteger

Unix timestamp in milliseconds when the invitation was created.

total_countinteger

Total number of organization invitations for the user.

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/users/{user_id}/organization-invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123"
}

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

Example responses1 example

200Organization invitations for a Clerk user.

user_org_invitations.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "organization_id": "org_2xyz789",
      "email_address": "ada@example.com",
      "role": "org:member",
      "status": "pending",
      "created_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/users/{user_id}/organization-memberships

https://api.vee3.io/v1/clerk/users/{user_id}/organization-memberships

5 tokens

List all organization memberships for a Clerk user.

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

Parameters4 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) whose memberships to list.

limitintegerOptional

Maximum number of organization memberships to return (1–500).

Default: 10 · min 1, max 500

offsetintegerOptional

Number of organization memberships to skip before returning results.

Default: 0 · min 0

Response7 fields

membershipsarrayitems

5 fields

Organization memberships for the user.

idstring

Organization membership id.

organization_idstring

Clerk organization id (org_...).

rolestring

Member role within the organization (e.g. org:admin, org:member).

created_atinteger

Unix timestamp in milliseconds when the membership was created.

updated_atinteger

Unix timestamp in milliseconds when the membership was last updated.

total_countinteger

Total number of organization memberships for the user.

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/users/{user_id}/organization-memberships"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123"
}

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

Example responses1 example

200Organization memberships for a Clerk user.

user_org_memberships.json

{
  "memberships": [
    {
      "id": "orgmem_2abc123",
      "organization_id": "org_2xyz789",
      "role": "org:member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000
    }
  ],
  "total_count": 1
}

GET/v1/clerk/waitlist-entries

https://api.vee3.io/v1/clerk/waitlist-entries

5 tokens

List waitlist entries in a connected Clerk application.

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

Parameters6 fields

clerk_instance_idstringOptional

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

limitintegerOptional

Maximum number of waitlist entries to return (1–500).

Default: 10

offsetintegerOptional

Number of waitlist entries to skip before returning results.

Default: 0

querystringOptional

Filter by email address or waitlist entry id.

statusstringOptional

Optional status filter: "pending", "invited", "rejected", or "completed".

order_bystringOptional

Sort order: created_at, email_address, or invited_at with optional + or - prefix. Defaults to -created_at.

Response8 fields

waitlist_entriesarrayitems

6 fields

Waitlist entries returned for the requested page.

idstring

Waitlist entry id (wle_...).

email_addressstring

Email address on the waitlist.

statusstring

Waitlist status: "pending", "invited", "rejected", or "completed".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

is_lockedboolean

Whether the entry is locked during batch processing.

total_countinteger

Total number of waitlist entries on this page.

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/waitlist-entries"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "limit": 10,
    "offset": 0,
    "query": "example"
}

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

Example responses1 example

200First page of waitlist entries.

waitlist_page.json

{
  "waitlist_entries": [
    {
      "id": "wle_2abc123",
      "email_address": "ada@example.com",
      "status": "pending",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "is_locked": false
    }
  ],
  "total_count": 1
}

POST/v1/clerk/users/{user_id}/lock

https://api.vee3.io/v1/clerk/users/{user_id}/lock

5 tokens

Lock a user account in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to lock.

Response6 fields

userobject

5 fields

Updated Clerk user object after locking.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/lock"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after being locked.

locked_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

POST/v1/clerk/email-addresses/{email_address_id}/prepare-verification

https://api.vee3.io/v1/clerk/email-addresses/{email_address_id}/prepare-verification

5 tokens

Send a verification code or link for a Clerk email address.

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

Parameters4 fields

clerk_instance_idstringOptional

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

email_address_idstringRequired

Clerk email address id (idn_...) to retrieve or modify.

strategy"email_code" | "email_link"Required

Verification strategy: email_code sends an OTP; email_link sends a link.

redirect_urlstringOptional

Required when strategy is email_link. URL the user is redirected to after clicking the link.

Response15 fields

email_addressobject

8 fields

Clerk email address summary after preparing verification.

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

verificationobject

5 fields

Verification object from the Clerk Backend API.

idstring

Verification id returned by prepare_verification.

statusstring

Verification status (verified, unverified, expired, or failed).

strategystring

Verification strategy (e.g. phone_code).

attemptsinteger

Number of verification attempts made.

expire_atinteger

Unix timestamp in milliseconds when the verification code expires.

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/email-addresses/{email_address_id}/prepare-verification"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "email_address_id": "idn_2abc123",
    "strategy": "email_code"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Verification initiated for a Clerk email address.

verification_prepared.json

{
  "email_address": {
    "id": "idn_2abc123",
    "user_id": "user_2abc123",
    "email_address": "ada@example.com",
    "verification_status": "unverified",
    "verified": false,
    "primary": false,
    "created_at": 1710000000000,
    "updated_at": 1710086400000
  },
  "verification": {
    "id": "ver_2abc123",
    "status": "unverified",
    "strategy": "email_code",
    "attempts": 0,
    "expire_at": 1710003600000
  }
}

POST/v1/clerk/phone-numbers/{phone_number_id}/prepare-verification

https://api.vee3.io/v1/clerk/phone-numbers/{phone_number_id}/prepare-verification

5 tokens

Send an SMS verification code to a Clerk phone number.

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

Parameters2 fields

clerk_instance_idstringOptional

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

phone_number_idstringRequired

Clerk phone number id (idn_... or phn_...) to retrieve or modify.

Response6 fields

verificationobject

5 fields

Verification object from the Clerk Backend API.

idstring

Verification id returned by prepare_verification.

statusstring

Verification status (verified, unverified, expired, or failed).

strategystring

Verification strategy (e.g. phone_code).

attemptsinteger

Number of verification attempts made.

expire_atinteger

Unix timestamp in milliseconds when the verification code expires.

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/phone-numbers/{phone_number_id}/prepare-verification"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "phone_number_id": "phn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200SMS verification code sent.

verification_prepared.json

{
  "verification": {
    "id": "ver_2abc123",
    "status": "unverified",
    "strategy": "phone_code",
    "attempts": 0,
    "expire_at": 1710003600000
  }
}

POST/v1/clerk/sessions/{session_id}/refresh

https://api.vee3.io/v1/clerk/sessions/{session_id}/refresh

5 tokens

Refresh an existing session in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

session_idstringRequired

Clerk session id (sess_...) to retrieve or modify.

Response8 fields

idstring

Clerk session id (sess_...).

user_idstring

Clerk user id (user_...) that owns this session.

statusstring

Current status of the session.

last_active_atinteger

Unix timestamp in milliseconds of the last activity on this session.

expire_atinteger

Unix timestamp in milliseconds when this session expires.

client_idstring

Clerk client id associated with this session.

created_atinteger

Unix timestamp in milliseconds when the session was created.

updated_atinteger

Unix timestamp in milliseconds when the session was last updated.

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

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/sessions/{session_id}/refresh"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "session_id": "sess_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Refreshed session from a connected Clerk application.

refreshed_session.json

{
  "id": "sess_2abc123",
  "user_id": "user_2abc123",
  "status": "active",
  "last_active_at": 1710000000000,
  "expire_at": 1710172800000,
  "client_id": "client_2abc123",
  "created_at": 1709913600000,
  "updated_at": 1710000000000
}

POST/v1/clerk/actor-tokens/{actor_token_id}/revoke

https://api.vee3.io/v1/clerk/actor-tokens/{actor_token_id}/revoke

5 tokens

Revoke an impersonation actor token in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

actor_token_idstringRequired

Clerk actor token id to revoke.

Response10 fields

actor_tokenobject

9 fields

Revoked Clerk actor token object from the Backend API.

idstring

Actor token id.

user_idstring

Clerk user id (user_...) being impersonated.

statusstring

Token status (pending, accepted, or revoked).

actorobject

1 field

Actor payload; includes sub with the impersonating user id.

substring

Clerk user id (user_...) of the impersonating actor.

tokenstring

Actor token secret. Treat as high-privilege — do not log.

urlstring

Optional sign-in URL that includes the actor token.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

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/actor-tokens/{actor_token_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "actor_token_id": "act_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Revoked Clerk actor token.

revoked_actor_token.json

{
  "actor_token": {
    "id": "act_2abc123",
    "user_id": "user_impersonated",
    "status": "revoked",
    "actor": {
      "sub": "user_actor"
    },
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/invitations/{invitation_id}/revoke

https://api.vee3.io/v1/clerk/invitations/{invitation_id}/revoke

5 tokens

Revoke a pending application invitation in 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.revoke_invitation

Parameters2 fields

clerk_instance_idstringOptional

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

invitation_idstringRequired

Clerk application invitation id (inv_...) to revoke.

Response6 fields

invitationobject

5 fields

Revoked Clerk invitation object from the Backend API.

idstring

Clerk invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

statusstring

Invitation status: "pending", "accepted", "revoked", or "expired".

created_atinteger

Unix timestamp in milliseconds when the invitation was created.

revokedboolean

Whether the invitation has been revoked.

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/invitations/{invitation_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "invitation_id": "inv_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Revoked Clerk invitation.

revoked_invitation.json

{
  "invitation": {
    "id": "inv_2abc123",
    "email_address": "ada@example.com",
    "status": "revoked",
    "created_at": 1710000000000,
    "revoked": true
  }
}

POST/v1/clerk/organizations/{organization_id}/invitations/{invitation_id}/revoke

https://api.vee3.io/v1/clerk/organizations/{organization_id}/invitations/{invitation_id}/revoke

5 tokens

Revoke a pending Clerk organization invitation.

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

Parameters3 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

invitation_idstringRequired

Clerk organization invitation id (orginv_...).

Response6 fields

invitationobject

5 fields

Revoked organization invitation summary.

idstring

Clerk organization invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

rolestring

Role assigned to the invitee (e.g. org:admin, org:member).

statusstring

Invitation status: pending, accepted, or revoked.

organization_idstring

Clerk organization id (org_...) that owns this invitation.

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/organizations/{organization_id}/invitations/{invitation_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "organization_id": "org_2xyz789",
    "invitation_id": "inv_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization invitation after revocation.

revoked_invitation.json

{
  "invitation": {
    "id": "inv_2abc123",
    "email_address": "ada@example.com",
    "role": "org:member",
    "status": "revoked",
    "organization_id": "org_2xyz456"
  }
}

POST/v1/clerk/sessions/{session_id}/revoke

https://api.vee3.io/v1/clerk/sessions/{session_id}/revoke

5 tokens

Revoke a session in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

session_idstringRequired

Clerk session id (sess_...) to retrieve or modify.

Response8 fields

idstring

Clerk session id (sess_...).

user_idstring

Clerk user id (user_...) that owns this session.

statusstring

Current status of the session.

last_active_atinteger

Unix timestamp in milliseconds of the last activity on this session.

expire_atinteger

Unix timestamp in milliseconds when this session expires.

client_idstring

Clerk client id associated with this session.

created_atinteger

Unix timestamp in milliseconds when the session was created.

updated_atinteger

Unix timestamp in milliseconds when the session was last updated.

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/sessions/{session_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "session_id": "sess_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Revoked session from a connected Clerk application.

revoked_session.json

{
  "id": "sess_2abc123",
  "user_id": "user_2abc123",
  "status": "revoked",
  "last_active_at": 1710000000000,
  "expire_at": 1710086400000,
  "client_id": "client_2abc123",
  "created_at": 1709913600000,
  "updated_at": 1710000000000
}

POST/v1/clerk/sign-in-tokens/{sign_in_token_id}/revoke

https://api.vee3.io/v1/clerk/sign-in-tokens/{sign_in_token_id}/revoke

5 tokens

Revoke a sign-in token in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

sign_in_token_idstringRequired

Clerk sign-in token id to revoke.

Response8 fields

sign_in_tokenobject

7 fields

Revoked Clerk sign-in token object from the Backend API.

idstring

Sign-in token id.

user_idstring

Clerk user id (user_...) the token is for.

statusstring

Token status (pending, accepted, or revoked).

tokenstring

Sign-in token secret. Treat as high-privilege — do not log.

urlstring

Optional sign-in URL that includes the token.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

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/sign-in-tokens/{sign_in_token_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "sign_in_token_id": "sit_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Revoked Clerk sign-in token.

revoked_sign_in_token.json

{
  "sign_in_token": {
    "id": "sit_2abc123",
    "user_id": "user_2abc123",
    "status": "revoked",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/users/{user_id}/unban

https://api.vee3.io/v1/clerk/users/{user_id}/unban

5 tokens

Remove a ban from a user in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to unban.

Response6 fields

userobject

5 fields

Updated Clerk user object after the unban.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/unban"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after being unbanned.

unbanned_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

POST/v1/clerk/users/{user_id}/unlock

https://api.vee3.io/v1/clerk/users/{user_id}/unlock

5 tokens

Unlock a locked user account in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to unlock.

Response6 fields

userobject

5 fields

Updated Clerk user object after unlocking.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/unlock"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after being unlocked.

unlocked_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

POST/v1/clerk/api-keys/verify

https://api.vee3.io/v1/clerk/api-keys/verify

5 tokens

Verify an API key secret against a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

secretstringRequired

API key secret to verify.

Response17 fields

api_keyobject

16 fields

Verified Clerk API key from the Backend API.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject

1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems

1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

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/api-keys/verify"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "secret": "sec_example_secret_value"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Verified Clerk API key.

verified_api_key.json

{
  "api_key": {
    "id": "ak_2abc123",
    "name": "server-integration",
    "subject": "user_2abc123",
    "revoked": false
  }
}

POST/v1/clerk/clients/verify

https://api.vee3.io/v1/clerk/clients/verify

5 tokens

Verify a client JWT from the Clerk Frontend API.

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

Parameters2 fields

clerk_instance_idstringOptional

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

tokenstringRequired

JWT representing the active Clerk client.

Response7 fields

clientobject

6 fields

Verified client object from the Backend API.

idstring

Client id.

session_idsarrayitems

1 field

Session ids associated with this client.

session_idstring

Clerk session id (sess_...).

last_active_session_idstring

Most recently active session id for this client.

created_atinteger

Unix timestamp in milliseconds when the client was created.

updated_atinteger

Unix timestamp in milliseconds when the client was last updated.

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/clients/verify"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "token": "m2m_example_token_secret"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Verified Clerk client from a JWT.

verified_client.json

{
  "client": {
    "id": "client_2abc123",
    "session_ids": [
      "sess_2abc123"
    ],
    "last_active_session_id": "sess_2abc123",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/m2m-tokens/verify

https://api.vee3.io/v1/clerk/m2m-tokens/verify

5 tokens

Verify an M2M token in 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.verify_m2m_token

Parameters2 fields

clerk_instance_idstringOptional

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

tokenstringRequired

M2M token string to verify.

Response9 fields

m2m_tokenobject

8 fields

Verified M2M token metadata from the Backend API.

idstring

M2M token id (mt_...).

subjectstring

Machine id (mch_...) that created or owns the token.

tokenstring

M2M token secret when returned on creation. Treat as high-privilege — do not log.

revokedboolean

Whether the token has been revoked.

expiredboolean

Whether the token has expired.

expirationinteger

Unix timestamp in milliseconds when the token expires.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

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/m2m-tokens/verify"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "token": "m2m_example_token_secret"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Verified M2M token metadata.

verified_m2m_token.json

{
  "m2m_token": {
    "id": "mt_f7f0ba8c3b4843ce7d85fcdd5e71853e",
    "subject": "mch_2abc123",
    "revoked": false,
    "expired": false,
    "expiration": 1710003600000,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/oauth-applications/access-tokens/verify

https://api.vee3.io/v1/clerk/oauth-applications/access-tokens/verify

5 tokens

Verify an OAuth access token issued by a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

access_tokenstringRequired

OAuth access token to verify.

Response10 fields

oauth_access_tokenobject

9 fields

Verification result from the Clerk Backend API.

objectstring

Object type when the token is active (e.g. "clerk_idp_oauth_access_token").

idstring

OAuth access token id (oat_...) when the token is active.

client_idstring

OAuth client id that issued the access token.

subjectstring

Authenticated user id (user_...) when the token is active.

scopesstring[]

Scopes granted to the access token.

revokedboolean

Whether the access token has been revoked.

expiredboolean

Whether the access token is expired.

expirationinteger

Expiration timestamp in seconds when the token is active.

activeboolean

False when a JWT-formatted token is not active (e.g. expired).

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/oauth-applications/access-tokens/verify"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "access_token": "oat_example_access_token"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses2 examples

200Active OAuth access token verification result.

active_oauth_access_token.json

{
  "oauth_access_token": {
    "object": "clerk_idp_oauth_access_token",
    "id": "oat_2abc123",
    "client_id": "client_2abc123",
    "subject": "user_2abc123",
    "scopes": [
      "profile",
      "email"
    ],
    "revoked": false,
    "expired": false,
    "expiration": 1716883200
  }
}

200Unknown, invalid, or inactive OAuth access token.

inactive_oauth_access_token.json

{
  "oauth_access_token": {
    "active": false
  }
}

POST/v1/clerk/organization-domains/{domain_id}/verify

https://api.vee3.io/v1/clerk/organization-domains/{domain_id}/verify

5 tokens

Mark an organization domain's DNS ownership as verified.

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

Parameters2 fields

clerk_instance_idstringOptional

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

domain_idstringRequired

Clerk organization domain id (dmn_...) to update, delete, or verify.

Response12 fields

domainobject

11 fields

Organization domain summary after ownership verification.

idstring

Clerk organization domain id (dmn_...).

namestring

Domain name (for example example.com).

organization_idstring

Clerk organization id (org_...) that owns this domain.

enrollment_modestring

Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

affiliation_email_addressstring

Affiliation email address for the domain, when set.

ownership_verification_statusstring

DNS ownership verification status (unverified, verified, failed, or expired).

affiliation_verification_statusstring

Affiliation verification status (unverified, verified, failed, or expired).

total_pending_invitationsinteger

Number of pending invitations associated with this domain.

total_pending_suggestionsinteger

Number of pending membership suggestions associated with this domain.

created_atinteger

Unix timestamp in milliseconds when the domain was created.

updated_atinteger

Unix timestamp in milliseconds when the domain was last updated.

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/organization-domains/{domain_id}/verify"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "domain_id": "dmn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization domain after ownership verification.

verified_domain.json

{
  "domain": {
    "id": "dmn_2abc123",
    "name": "example.com",
    "organization_id": "org_2xyz456",
    "enrollment_mode": "automatic_invitation",
    "affiliation_email_address": null,
    "ownership_verification_status": "verified",
    "affiliation_verification_status": "verified",
    "total_pending_invitations": 0,
    "total_pending_suggestions": 0,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/users/{user_id}/verify-password

https://api.vee3.io/v1/clerk/users/{user_id}/verify-password

5 tokens

Verify a user's password in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

passwordstringRequired

Plain-text password to verify.

Response1 field

verifiedboolean

True when the password matches the user's stored password.

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/users/{user_id}/verify-password"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "password": "SecurePassword123!"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "verified": true
}

POST/v1/clerk/users/{user_id}/verify-totp

https://api.vee3.io/v1/clerk/users/{user_id}/verify-totp

5 tokens

Verify a TOTP or backup code for a user in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

codestringRequired

TOTP or backup code to verify.

Response2 fields

verifiedboolean

True when the code is valid.

code_typestring

Type of code verified (for example totp or backup_code).

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/users/{user_id}/verify-totp"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "code": "424242"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "verified": true,
  "code_type": "totp"
}

POST/v1/clerk/role-sets/{role_set_id}/roles

https://api.vee3.io/v1/clerk/role-sets/{role_set_id}/roles

8 tokens

Add roles to a role set in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

role_set_idstringRequired

Clerk role set id or key to retrieve, update, or modify.

role_keysarrayRequired

Role keys to add to the role set.

default_role_keystringOptional

Updated default role key after adding roles.

creator_role_keystringOptional

Updated creator role key after adding roles.

Response35 fields

role_setobject

34 fields

Updated role set summary.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems

8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject

8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject

8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

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/role-sets/{role_set_id}/roles"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "role_set_id": "orgroleset_2abc123",
    "role_keys": ["org:member"]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Role set after adding roles.

role_set_with_roles.json

{
  "role_set": {
    "id": "rs_2abc123",
    "name": "Default",
    "key": "default",
    "description": "Default organization roles",
    "roles": [
      {
        "id": "orgrl_2member",
        "name": "Member",
        "key": "org:member",
        "description": "Organization member",
        "created_at": 1710000000000,
        "updated_at": 1710000000000,
        "members_count": 42,
        "has_members": true
      }
    ],
    "default_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "creator_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "type": "default",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/organizations/{organization_id}/billing/credit-balance/adjust

https://api.vee3.io/v1/clerk/organizations/{organization_id}/billing/credit-balance/adjust

8 tokens

Increase or decrease billing credit for a Clerk organization.

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

Parameters7 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

amountintegerRequired

Credit adjustment amount in cents (minimum 1).

min 1

action"increase" | "decrease"Required

Credit adjustment action: "increase" or "decrease".

idempotency_keystringRequired

Unique key to make the credit adjustment idempotent.

currencystringOptional

ISO currency code for the credit adjustment.

notestringOptional

Optional note describing the credit adjustment.

Response9 fields

credit_ledgerobject

8 fields

Credit ledger entry created by the adjustment.

idstring

Clerk billing credit ledger entry id.

payer_idstring

Payer id (user_... or org_...) for the ledger entry.

source_typestring

Source type for the credit adjustment.

source_idstring

Source id for the credit adjustment.

notestring

Optional note describing the credit adjustment.

created_atstring

RFC3339 timestamp when the ledger entry was created.

amountinteger

Credit adjustment amount in cents.

currencystring

ISO currency code for the credit adjustment.

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/organizations/{organization_id}/billing/credit-balance/adjust"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "organization_id": "org_2xyz789",
    "amount": 1000,
    "action": "ban",
    "idempotency_key": "idem_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Credit ledger entry after adjusting an organization credit balance.

adjusted_organization_credit_balance.json

{
  "credit_ledger": {
    "id": "cl_2abc123",
    "payer_id": "org_2abc123",
    "source_type": "manual_adjustment",
    "source_id": "adj_2abc123",
    "note": "Promotional credit",
    "created_at": "2024-03-10T12:00:00Z",
    "amount": 5000,
    "currency": "usd"
  }
}

POST/v1/clerk/users/{user_id}/billing/credit-balance/adjust

https://api.vee3.io/v1/clerk/users/{user_id}/billing/credit-balance/adjust

8 tokens

Increase or decrease billing credit for a Clerk user.

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

Parameters7 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

amountintegerRequired

Credit adjustment amount in cents (minimum 1).

min 1

action"increase" | "decrease"Required

Credit adjustment action: "increase" or "decrease".

idempotency_keystringRequired

Unique key to make the credit adjustment idempotent.

currencystringOptional

ISO currency code for the credit adjustment.

notestringOptional

Optional note describing the credit adjustment.

Response9 fields

credit_ledgerobject

8 fields

Credit ledger entry created by the adjustment.

idstring

Clerk billing credit ledger entry id.

payer_idstring

Payer id (user_... or org_...) for the ledger entry.

source_typestring

Source type for the credit adjustment.

source_idstring

Source id for the credit adjustment.

notestring

Optional note describing the credit adjustment.

created_atstring

RFC3339 timestamp when the ledger entry was created.

amountinteger

Credit adjustment amount in cents.

currencystring

ISO currency code for the credit adjustment.

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/users/{user_id}/billing/credit-balance/adjust"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "amount": 1000,
    "action": "ban",
    "idempotency_key": "idem_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Credit ledger entry after adjusting a user credit balance.

adjusted_user_credit_balance.json

{
  "credit_ledger": {
    "id": "cl_2abc123",
    "payer_id": "user_2abc123",
    "source_type": "manual_adjustment",
    "source_id": "adj_2abc123",
    "note": "Promotional credit",
    "created_at": "2024-03-10T12:00:00Z",
    "amount": 5000,
    "currency": "usd"
  }
}

POST/v1/clerk/organization-roles/{role_id}/permissions/{permission_id}

https://api.vee3.io/v1/clerk/organization-roles/{role_id}/permissions/{permission_id}

8 tokens

Assign a permission to an organization role in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

role_idstringRequired

Clerk organization role id to retrieve, update, delete, or assign permissions to.

permission_idstringRequired

Clerk organization permission id to retrieve, update, delete, or assign to a role.

Response16 fields

organization_roleobject

15 fields

Organization role summary after assigning the permission.

idstring

Clerk organization role id.

namestring

Role display name.

keystring

Role key used in memberships.

descriptionstring

Role description.

is_creator_eligibleboolean

Whether this role may be assigned as organization creator.

permissionsarrayitems

7 fields

Permissions assigned to this role.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

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/organization-roles/{role_id}/permissions/{permission_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "role_id": "orgrole_2abc123",
    "permission_id": "orgperm_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Role after permission assignment.

role_with_permission.json

{
  "organization_role": {
    "id": "orgrl_2abc123",
    "name": "Admin",
    "key": "org:admin",
    "description": "Organization administrator",
    "is_creator_eligible": true,
    "permissions": [
      {
        "id": "orgperm_2abc123",
        "name": "Manage billing",
        "key": "org:sys_billing:manage",
        "description": "Manage organization billing",
        "type": "system",
        "created_at": 1710000000000,
        "updated_at": 1710000000000
      }
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/users/ban

https://api.vee3.io/v1/clerk/users/ban

8 tokens

Ban multiple users from signing in to a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idsarrayRequired

List of Clerk user ids (user_...) to ban.

Response7 fields

usersarrayitems

5 fields

Updated user summaries for all banned users.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

total_countinteger

Number of users that were banned.

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/users/ban"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_ids": ["user_2abc123"]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Users after a bulk ban operation.

bulk_banned_users.json

{
  "users": [
    {
      "id": "user_2abc123",
      "first_name": "Ada",
      "primary_email_address": "ada@example.com",
      "created_at": 1710000000000
    }
  ],
  "total_count": 1
}

POST/v1/clerk/users/unban

https://api.vee3.io/v1/clerk/users/unban

8 tokens

Remove bans from multiple users in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idsarrayRequired

List of Clerk user ids (user_...) to unban.

Response7 fields

usersarrayitems

5 fields

Updated user summaries for all unbanned users.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

total_countinteger

Number of users that were unbanned.

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/users/unban"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_ids": ["user_2abc123"]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Users after a bulk unban operation.

bulk_unbanned_users.json

{
  "users": [
    {
      "id": "user_2abc123",
      "first_name": "Ada",
      "primary_email_address": "ada@example.com",
      "created_at": 1710000000000
    }
  ],
  "total_count": 1
}

POST/v1/clerk/billing/subscription-items/{subscription_item_id}/cancel

https://api.vee3.io/v1/clerk/billing/subscription-items/{subscription_item_id}/cancel

8 tokens

Cancel a billing subscription item in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

subscription_item_idstringRequired

Clerk billing subscription item id.

end_nowbooleanOptional

When true, end the subscription immediately instead of at period end.

Response12 fields

subscription_itemobject

11 fields

Canceled subscription item summary.

idstring

Clerk billing subscription item id.

statusstring

Subscription item status.

plan_idstring

Billing plan id for the subscription item.

price_idstring

Billing price id for the subscription item.

payer_idstring

Payer id (user_... or org_...) for the subscription item.

is_free_trialboolean

Whether the subscription item is in a free trial.

period_startinteger

Unix timestamp in milliseconds when the current billing period started.

period_endinteger

Unix timestamp in milliseconds when the current billing period ends.

canceled_atinteger

Unix timestamp in milliseconds when cancellation was requested.

ended_atinteger

Unix timestamp in milliseconds when the subscription item ended.

past_due_atinteger

Unix timestamp in milliseconds when the subscription item became past due.

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/billing/subscription-items/{subscription_item_id}/cancel"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "subscription_item_id": "si_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Subscription item after cancellation.

canceled_subscription_item.json

{
  "subscription_item": {
    "id": "si_2abc123",
    "status": "canceled",
    "plan_id": "plan_2abc123",
    "price_id": "price_2abc123",
    "payer_id": "user_2abc123",
    "is_free_trial": false,
    "period_start": 1710000000000,
    "period_end": 1712592000000,
    "canceled_at": 1710000000000
  }
}

POST/v1/clerk/allowlist-identifiers

https://api.vee3.io/v1/clerk/allowlist-identifiers

8 tokens

Add an email, phone, domain pattern, or Web3 wallet to the Clerk allowlist.

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

Parameters3 fields

clerk_instance_idstringOptional

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

identifierstringRequired

Identifier to allowlist: email, wildcard domain (*@example.com), E.164 phone (+15555555555), or Web3 wallet address.

notifybooleanOptional

When true, notify the user by email or SMS that they were added to the allowlist.

Response7 fields

identifierobject

6 fields

Created allowlist identifier object from the Backend API.

idstring

Allowlist identifier id (alid_...).

identifierstring

Allowlisted email, phone, domain pattern, or Web3 wallet address.

identifier_typestring

Type of identifier: "email_address", "phone_number", or "web3_wallet".

invitation_idstring

Clerk invitation id (inv_...) when the entry was created from an invitation.

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

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/allowlist-identifiers"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "identifier": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created allowlist identifier.

created_allowlist_identifier.json

{
  "identifier": {
    "id": "alid_2abc123",
    "identifier": "ada@example.com",
    "identifier_type": "email_address",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/billing/subscription-items/{subscription_item_id}/price-transitions

https://api.vee3.io/v1/clerk/billing/subscription-items/{subscription_item_id}/price-transitions

8 tokens

Transition a billing subscription item from one price to another.

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

Parameters4 fields

clerk_instance_idstringOptional

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

subscription_item_idstringRequired

Clerk billing subscription item id.

from_price_idstringRequired

Current billing price id to transition from.

to_price_idstringRequired

Target billing price id to transition to.

Response14 fields

price_transitionobject

13 fields

Price transition result from Clerk.

objectstring

Clerk object type for the price transition response.

subscription_itemobject

11 fields

Updated subscription item after the price transition.

idstring

Clerk billing subscription item id.

statusstring

Subscription item status.

plan_idstring

Billing plan id for the subscription item.

price_idstring

Billing price id for the subscription item.

payer_idstring

Payer id (user_... or org_...) for the subscription item.

is_free_trialboolean

Whether the subscription item is in a free trial.

period_startinteger

Unix timestamp in milliseconds when the current billing period started.

period_endinteger

Unix timestamp in milliseconds when the current billing period ends.

canceled_atinteger

Unix timestamp in milliseconds when cancellation was requested.

ended_atinteger

Unix timestamp in milliseconds when the subscription item ended.

past_due_atinteger

Unix timestamp in milliseconds when the subscription item became past due.

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/billing/subscription-items/{subscription_item_id}/price-transitions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "subscription_item_id": "si_2abc123",
    "from_price_id": "price_2abc123",
    "to_price_id": "price_2xyz789"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Subscription item after a price transition.

price_transition.json

{
  "price_transition": {
    "object": "billing.price_transition",
    "subscription_item": {
      "id": "si_2abc123",
      "status": "active",
      "plan_id": "plan_2abc123",
      "price_id": "price_2abc123",
      "payer_id": "user_2abc123",
      "is_free_trial": false,
      "period_start": 1710000000000,
      "period_end": 1712592000000
    }
  }
}

POST/v1/clerk/blocklist-identifiers

https://api.vee3.io/v1/clerk/blocklist-identifiers

8 tokens

Block an email, phone, domain, or Web3 wallet in 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.create_blocklist_identifier

Parameters2 fields

clerk_instance_idstringOptional

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

identifierstringRequired

Identifier to block: email, domain, E.164 phone (+15555555555), or Web3 wallet address.

Response6 fields

identifierobject

5 fields

Created blocklist identifier object from the Backend API.

idstring

Blocklist identifier id (blid_...).

identifierstring

Blocklisted email, domain, phone, or Web3 wallet address.

identifier_typestring

Type of identifier: "email_address", "phone_number", or "web3_wallet".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

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/blocklist-identifiers"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "identifier": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created blocklist identifier.

created_blocklist_identifier.json

{
  "identifier": {
    "id": "blid_2abc123",
    "identifier": "spam@example.com",
    "identifier_type": "email_address",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/enterprise-connections/{connection_id}/test-runs

https://api.vee3.io/v1/clerk/enterprise-connections/{connection_id}/test-runs

8 tokens

Start an SSO test flow for an enterprise connection.

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

Parameters2 fields

clerk_instance_idstringOptional

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

connection_idstringRequired

Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.

Response1 field

urlstring

Short-lived URL to start the enterprise SSO test flow.

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/enterprise-connections/{connection_id}/test-runs"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "connection_id": "conn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200URL to initiate an SSO test run.

enterprise_connection_test_run_url.json

{
  "url": "https://accounts.example.com/test/entc_2abc123?token=short_lived"
}

POST/v1/clerk/machines/{machine_id}/scopes

https://api.vee3.io/v1/clerk/machines/{machine_id}/scopes

8 tokens

Grant one machine access to another machine in 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.create_machine_scope

Parameters3 fields

clerk_instance_idstringOptional

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

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

to_machine_idstringRequired

Target machine id (mch_...) to grant access to.

Response5 fields

machine_scopeobject

4 fields

Created machine scope from the Backend API.

objectstring

Object type (machine_scope).

from_machine_idstring

Machine id that was granted access.

to_machine_idstring

Machine id that can be accessed.

created_atinteger

Unix timestamp in milliseconds when the scope was created.

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/machines/{machine_id}/scopes"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "machine_id": "mch_2abc123",
    "to_machine_id": "mch_peer456"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Machine scope granting access between machines.

created_machine_scope.json

{
  "machine_scope": {
    "object": "machine_scope",
    "from_machine_id": "mch_2abc123",
    "to_machine_id": "mch_2def456",
    "created_at": 1710000000000
  }
}

POST/v1/clerk/webhooks/svix/dashboard

https://api.vee3.io/v1/clerk/webhooks/svix/dashboard

8 tokens

Generate a temporary Svix management dashboard URL for a connected Clerk application.

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

Parameters1 field

clerk_instance_idstringOptional

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

Response2 fields

svixobject

1 field

Temporary Svix dashboard URL from the Clerk Backend API.

svix_urlstring

Temporary Svix URL. Treat as sensitive — do not log.

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/webhooks/svix/dashboard"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {

}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Temporary Svix dashboard login URL.

svix_dashboard_url.json

{
  "svix": {
    "svix_url": "https://app.svix.com/login?token=example"
  }
}

DELETE/v1/clerk/allowlist-identifiers/{identifier_id}

https://api.vee3.io/v1/clerk/allowlist-identifiers/{identifier_id}

8 tokens

Remove an identifier from the Clerk allowlist.

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

Parameters2 fields

clerk_instance_idstringOptional

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

identifier_idstringRequired

Allowlist or blocklist identifier id (alid_... or blid_...) to delete.

Response4 fields

deleted_identifierobject

3 fields

Clerk deleted-object payload confirming removal.

objectstring

Clerk object type for the deleted resource.

idstring

Deleted identifier id.

deletedboolean

Whether the identifier was deleted.

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/allowlist-identifiers/{identifier_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "identifier_id": "identifier_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted allowlist identifier confirmation.

deleted_allowlist_identifier.json

{
  "deleted_identifier": {
    "object": "allowlist_identifier",
    "id": "alid_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/blocklist-identifiers/{identifier_id}

https://api.vee3.io/v1/clerk/blocklist-identifiers/{identifier_id}

8 tokens

Remove an identifier from the Clerk blocklist.

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

Parameters2 fields

clerk_instance_idstringOptional

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

identifier_idstringRequired

Allowlist or blocklist identifier id (alid_... or blid_...) to delete.

Response4 fields

deleted_identifierobject

3 fields

Clerk deleted-object payload confirming removal.

objectstring

Clerk object type for the deleted resource.

idstring

Deleted identifier id.

deletedboolean

Whether the identifier was deleted.

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/blocklist-identifiers/{identifier_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "identifier_id": "identifier_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted blocklist identifier confirmation.

deleted_blocklist_identifier.json

{
  "deleted_identifier": {
    "object": "blocklist_identifier",
    "id": "blid_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/machines/{machine_id}/scopes/{scope_id}

https://api.vee3.io/v1/clerk/machines/{machine_id}/scopes/{scope_id}

8 tokens

Remove access from one machine to another in 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.delete_machine_scope

Parameters3 fields

clerk_instance_idstringOptional

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

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

scope_idstringRequired

Target machine id (mch_...) for the scope to remove.

Response5 fields

deleted_machine_scopeobject

4 fields

Deleted machine scope confirmation from the Backend API.

objectstring

Object type (machine_scope).

from_machine_idstring

Machine id that was granted access.

to_machine_idstring

Machine id that can be accessed.

created_atinteger

Unix timestamp in milliseconds when the scope was created.

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/machines/{machine_id}/scopes/{scope_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "machine_id": "mch_2abc123",
    "scope_id": "mch_peer456"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Confirmation that the machine scope was removed.

deleted_machine_scope.json

{
  "deleted_machine_scope": {
    "object": "machine_scope",
    "from_machine_id": "mch_2abc123",
    "to_machine_id": "mch_2def456",
    "created_at": 1710000000000
  }
}

DELETE/v1/clerk/organizations/{organization_id}/memberships/{user_id}

https://api.vee3.io/v1/clerk/organizations/{organization_id}/memberships/{user_id}

8 tokens

Remove a user from an organization in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to remove the member from.

user_idstringRequired

Clerk user id (user_...) of the member to remove.

Response5 fields

membershipobject

4 fields

Deleted organization membership object, when returned.

idstring

Clerk organization membership id (orgmem_...).

user_idstring

Clerk user id (user_...) of the member.

rolestring

Role of the member in the organization (e.g. org:admin, org:member).

created_atinteger

Unix timestamp in milliseconds when the membership was created.

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/organizations/{organization_id}/memberships/{user_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789",
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted organization membership.

deleted_membership.json

{
  "membership": {
    "id": "orgmem_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/users/{user_id}/backup-codes

https://api.vee3.io/v1/clerk/users/{user_id}/backup-codes

8 tokens

Remove all backup codes for a user in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

Response6 fields

userobject

5 fields

Updated Clerk user object after backup codes were removed.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/backup-codes"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "user": {
    "id": "user_2abc123"
  }
}

DELETE/v1/clerk/users/{user_id}/external-accounts/{external_account_id}

https://api.vee3.io/v1/clerk/users/{user_id}/external-accounts/{external_account_id}

8 tokens

Unlink an OAuth or social external account from a user.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

external_account_idstringRequired

External account id (for example ea_...) to unlink.

Response3 fields

external_accountobject

2 fields

Deleted external account object from the Clerk Backend API.

idstring

External account id (ea_...).

providerstring

OAuth provider id (for example oauth_google).

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/users/{user_id}/external-accounts/{external_account_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "external_account_id": "ea_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "external_account": {
    "id": "ea_2abc123",
    "provider": "oauth_google"
  }
}

DELETE/v1/clerk/users/{user_id}/passkeys/{passkey_id}

https://api.vee3.io/v1/clerk/users/{user_id}/passkeys/{passkey_id}

8 tokens

Remove a passkey from a user in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

passkey_idstringRequired

Passkey identification id to delete.

Response6 fields

userobject

5 fields

Updated Clerk user object after the passkey was removed.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/passkeys/{passkey_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "passkey_id": "pkey_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "user": {
    "id": "user_2abc123"
  }
}

DELETE/v1/clerk/users/{user_id}/totp

https://api.vee3.io/v1/clerk/users/{user_id}/totp

8 tokens

Remove all TOTP authenticators for a user in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

Response6 fields

userobject

5 fields

Updated Clerk user object after TOTP was removed.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/totp"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "user": {
    "id": "user_2abc123"
  }
}

DELETE/v1/clerk/users/{user_id}/web3-wallets/{web3_wallet_id}

https://api.vee3.io/v1/clerk/users/{user_id}/web3-wallets/{web3_wallet_id}

8 tokens

Remove a Web3 wallet from a user in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

web3_wallet_idstringRequired

Web3 wallet identification id to delete.

Response6 fields

userobject

5 fields

Updated Clerk user object after the Web3 wallet was removed.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/web3-wallets/{web3_wallet_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "web3_wallet_id": "web3_wallet_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "user": {
    "id": "user_2abc123"
  }
}

POST/v1/clerk/users/{user_id}/disable-mfa

https://api.vee3.io/v1/clerk/users/{user_id}/disable-mfa

8 tokens

Disable all MFA methods for a user in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

Response6 fields

userobject

5 fields

Updated Clerk user object after MFA was disabled.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/disable-mfa"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "user": {
    "id": "user_2abc123"
  }
}

POST/v1/clerk/billing/subscription-items/{subscription_item_id}/extend-free-trial

https://api.vee3.io/v1/clerk/billing/subscription-items/{subscription_item_id}/extend-free-trial

8 tokens

Extend the free trial on a billing subscription item.

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

Parameters3 fields

clerk_instance_idstringOptional

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

subscription_item_idstringRequired

Clerk billing subscription item id.

extend_tostringRequired

RFC3339 timestamp to extend the free trial until.

Response12 fields

subscription_itemobject

11 fields

Subscription item after extending the free trial.

idstring

Clerk billing subscription item id.

statusstring

Subscription item status.

plan_idstring

Billing plan id for the subscription item.

price_idstring

Billing price id for the subscription item.

payer_idstring

Payer id (user_... or org_...) for the subscription item.

is_free_trialboolean

Whether the subscription item is in a free trial.

period_startinteger

Unix timestamp in milliseconds when the current billing period started.

period_endinteger

Unix timestamp in milliseconds when the current billing period ends.

canceled_atinteger

Unix timestamp in milliseconds when cancellation was requested.

ended_atinteger

Unix timestamp in milliseconds when the subscription item ended.

past_due_atinteger

Unix timestamp in milliseconds when the subscription item became past due.

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/billing/subscription-items/{subscription_item_id}/extend-free-trial"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "subscription_item_id": "si_2abc123",
    "extend_to": "2026-12-31T23:59:59Z"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Subscription item after extending the free trial.

extended_subscription_trial.json

{
  "subscription_item": {
    "id": "si_2abc123",
    "status": "active",
    "plan_id": "plan_2abc123",
    "price_id": "price_2abc123",
    "payer_id": "user_2abc123",
    "is_free_trial": true,
    "period_start": 1710000000000,
    "period_end": 1715184000000
  }
}

DELETE/v1/clerk/organization-roles/{role_id}/permissions/{permission_id}

https://api.vee3.io/v1/clerk/organization-roles/{role_id}/permissions/{permission_id}

8 tokens

Remove a permission from an organization role in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

role_idstringRequired

Clerk organization role id to retrieve, update, delete, or assign permissions to.

permission_idstringRequired

Clerk organization permission id to retrieve, update, delete, or assign to a role.

Response16 fields

organization_roleobject

15 fields

Organization role summary after removing the permission.

idstring

Clerk organization role id.

namestring

Role display name.

keystring

Role key used in memberships.

descriptionstring

Role description.

is_creator_eligibleboolean

Whether this role may be assigned as organization creator.

permissionsarrayitems

7 fields

Permissions assigned to this role.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

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/organization-roles/{role_id}/permissions/{permission_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "role_id": "orgrole_2abc123",
    "permission_id": "orgperm_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Role after permission removal.

role_without_permission.json

{
  "organization_role": {
    "id": "orgrl_2abc123",
    "name": "Admin",
    "key": "org:admin",
    "description": "Organization administrator",
    "is_creator_eligible": true,
    "permissions": [
      {
        "id": "orgperm_2abc123",
        "name": "Manage billing",
        "key": "org:sys_billing:manage",
        "description": "Manage organization billing",
        "type": "system",
        "created_at": 1710000000000,
        "updated_at": 1710000000000
      }
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

PUT/v1/clerk/organizations/{organization_id}/metadata/{metadata_type}

https://api.vee3.io/v1/clerk/organizations/{organization_id}/metadata/{metadata_type}

8 tokens

Replace one metadata object for a Clerk organization.

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

Parameters4 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

metadata_type"public" | "private"Required

Metadata type to replace: "public" or "private".

metadataobjectRequired

New metadata object to set (replaces all existing keys).

Response6 fields

organizationobject

5 fields

Updated Clerk organization summary.

idstring

Clerk organization id (org_...).

namestring

Organization display name.

slugstring

URL-friendly organization slug, if set.

members_countinteger

Current number of members in the organization.

created_atinteger

Unix timestamp in milliseconds when the organization was created.

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/organizations/{organization_id}/metadata/{metadata_type}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789",
    "metadata_type": "public",
    "metadata": {"plan":"enterprise"}
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization after a metadata replacement.

replaced_metadata.json

{
  "organization": {
    "id": "org_2abc123",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "members_count": 12,
    "created_at": 1710000000000
  }
}

PUT/v1/clerk/users/{user_id}/email-address

https://api.vee3.io/v1/clerk/users/{user_id}/email-address

8 tokens

Replace a Clerk user's email addresses with a single verified primary email.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

email_addressstringRequired

New primary email address for the user.

Response9 fields

email_addressobject

8 fields

New primary Clerk email address summary.

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

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/users/{user_id}/email-address"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "email_address": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user primary email replaced.

replaced_email_address.json

{
  "email_address": {
    "id": "idn_2abc123",
    "user_id": "user_2abc123",
    "email_address": "new-primary@example.com",
    "verification_status": "verified",
    "verified": true,
    "primary": true,
    "created_at": 1710086400000,
    "updated_at": 1710086400000
  }
}

PUT/v1/clerk/users/{user_id}/metadata/{metadata_type}

https://api.vee3.io/v1/clerk/users/{user_id}/metadata/{metadata_type}

8 tokens

Replace a single metadata namespace for a Clerk user.

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

Parameters4 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) whose metadata to replace.

metadata_type"public_metadata" | "private_metadata" | "unsafe_metadata"Required

Metadata namespace to replace.

metadataobjectRequired

New metadata dict that fully replaces the chosen namespace. Pass an empty object to clear all keys.

Response6 fields

userobject

5 fields

Updated Clerk user object after the metadata replacement.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/metadata/{metadata_type}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "metadata_type": "public",
    "metadata": {"plan":"enterprise"}
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after a metadata namespace replacement.

replaced_metadata_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

PUT/v1/clerk/users/{user_id}/phone-number

https://api.vee3.io/v1/clerk/users/{user_id}/phone-number

8 tokens

Replace a Clerk user's primary phone number.

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

Parameters4 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

phone_numberstringRequired

New phone number in E.164 format.

identification_statusstringOptional

Status for the replacement number: verified (default) or reserved.

Response6 fields

phone_numberobject

5 fields

Replacement Clerk phone number object from the Backend API.

idstring

Clerk phone number id.

phone_numberstring

Phone number in E.164 format.

verifiedboolean

Whether the phone number is verified.

reserved_for_second_factorboolean

Whether the phone number is reserved for multi-factor authentication.

default_second_factorboolean

Whether this is the user's default second factor.

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/users/{user_id}/phone-number"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "phone_number": "+15551234567"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200User phone number replaced.

phone_number_replaced.json

{
  "phone_number": {
    "id": "idn_2abc123",
    "phone_number": "+15551234567",
    "verified": true,
    "reserved_for_second_factor": false,
    "default_second_factor": false
  }
}

POST/v1/clerk/admin-portal-link-tokens/{admin_portal_link_token_id}/revoke

https://api.vee3.io/v1/clerk/admin-portal-link-tokens/{admin_portal_link_token_id}/revoke

8 tokens

Revoke an admin portal link token in 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.revoke_admin_portal_link_token

Parameters3 fields

clerk_instance_idstringOptional

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

admin_portal_link_token_idstringRequired

Admin portal link token id (aplt_...) to revoke.

revocation_reasonstringOptional

Optional reason recorded when revoking the link token.

Response9 fields

admin_portal_link_tokenobject

8 fields

Revoked admin portal link token from the Backend API.

idstring

Admin portal link token id (aplt_...).

admin_portal_link_idstring

Origin admin portal link id (apl_...).

instance_idstring

Clerk instance id (ins_...).

tokenstring

Single-use admin portal link token when returned on creation. Treat as high-privilege — do not log.

revokedboolean

Whether the link token has been revoked.

expiredboolean

Whether the link token has expired.

expirationinteger

Unix timestamp in milliseconds when the link token expires.

created_atinteger

Unix timestamp in milliseconds when the link token was created.

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/admin-portal-link-tokens/{admin_portal_link_token_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "admin_portal_link_token_id": "aplt_3beecc9c60adb5f9b850e91a83beecc9"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Admin portal link token after revocation.

revoked_admin_portal_link_token.json

{
  "admin_portal_link_token": {
    "id": "aplt_3beecc9c60adb5f9b850e91a83beecc9",
    "admin_portal_link_id": "apl_3beecc9c60adb5f9b850e91a8d2",
    "instance_id": "ins_2abc123",
    "revoked": true,
    "expired": false,
    "expiration": 1710003600000,
    "created_at": 1710000000000
  }
}

POST/v1/clerk/api-keys/{api_key_id}/revoke

https://api.vee3.io/v1/clerk/api-keys/{api_key_id}/revoke

8 tokens

Revoke an API key in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

api_key_idstringRequired

Clerk API key id (ak_...) to retrieve, update, delete, or revoke.

revocation_reasonstringOptional

Optional reason recorded when revoking the API key.

Response17 fields

api_keyobject

16 fields

Revoked Clerk API key from the Backend API.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject

1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems

1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

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/api-keys/{api_key_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "api_key_id": "ak_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Revoked Clerk API key.

revoked_api_key.json

{
  "api_key": {
    "id": "ak_2abc123",
    "name": "server-integration",
    "revoked": true,
    "revocation_reason": "Rotated credentials",
    "updated_at": 1710001000000
  }
}

POST/v1/clerk/m2m-tokens/{m2m_token_id}/revoke

https://api.vee3.io/v1/clerk/m2m-tokens/{m2m_token_id}/revoke

8 tokens

Revoke an M2M token in 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.revoke_m2m_token

Parameters2 fields

clerk_instance_idstringOptional

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

m2m_token_idstringRequired

Clerk M2M token id (mt_...) to revoke.

Response9 fields

m2m_tokenobject

8 fields

Revoked M2M token from the Backend API.

idstring

M2M token id (mt_...).

subjectstring

Machine id (mch_...) that created or owns the token.

tokenstring

M2M token secret when returned on creation. Treat as high-privilege — do not log.

revokedboolean

Whether the token has been revoked.

expiredboolean

Whether the token has expired.

expirationinteger

Unix timestamp in milliseconds when the token expires.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

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/m2m-tokens/{m2m_token_id}/revoke"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "m2m_token_id": "mt_f7f0ba8c3b4843ce7d85fcdd5e71853e"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200M2M token after revocation.

revoked_m2m_token.json

{
  "m2m_token": {
    "id": "mt_f7f0ba8c3b4843ce7d85fcdd5e71853e",
    "subject": "mch_2abc123",
    "revoked": true,
    "expired": false,
    "expiration": 1710003600000,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/users/{user_id}/password-compromised

https://api.vee3.io/v1/clerk/users/{user_id}/password-compromised

8 tokens

Mark a user's password as compromised so they must reset on next sign-in.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

revoke_all_sessionsbooleanOptional

When true, revoke all active sessions for the user.

Response6 fields

userobject

5 fields

Updated Clerk user object after marking password compromised.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/password-compromised"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "user": {
    "id": "user_2abc123"
  }
}

DELETE/v1/clerk/users/{user_id}/password-compromised

https://api.vee3.io/v1/clerk/users/{user_id}/password-compromised

8 tokens

Clear the compromised-password flag for a user.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

Response6 fields

userobject

5 fields

Updated Clerk user object after clearing the compromised-password flag.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/password-compromised"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Successful response.

success.json

{
  "user": {
    "id": "user_2abc123"
  }
}

PATCH/v1/clerk/api-keys/{api_key_id}

https://api.vee3.io/v1/clerk/api-keys/{api_key_id}

8 tokens

Update an API key in a connected Clerk application.

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

Parameters7 fields

clerk_instance_idstringOptional

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

api_key_idstringRequired

Clerk API key id (ak_...) to retrieve, update, delete, or revoke.

claimsobjectOptional

Updated custom claims for tokens minted from this API key.

scopesarrayOptional

Updated permission scopes for the API key.

descriptionstringOptional

Updated description for the API key.

subjectstringOptional

Updated subject (user_... or org_...).

seconds_until_expirationnumberOptional

Updated seconds until expiration from now.

Response17 fields

api_keyobject

16 fields

Updated Clerk API key from the Backend API.

idstring

Clerk API key id (ak_...).

namestring

Human-readable API key name.

subjectstring

Subject the API key is scoped to (user_... or org_...).

key_typestring

API key type (typically "api_key").

descriptionstring

Optional description for the API key.

claimsobject

1 field

Custom claims embedded in tokens minted from this API key.

claim_keystring

A key in the custom claims object.

scopesarrayitems

1 field

Permission scopes granted to this API key.

itemstring

A single scope string.

created_bystring

User id that created the API key, when set.

created_atinteger

Unix timestamp in milliseconds when the API key was created.

updated_atinteger

Unix timestamp in milliseconds when the API key was last updated.

expirationinteger

Unix timestamp in milliseconds when the API key expires, if set.

revokedboolean

Whether the API key has been revoked.

revocation_reasonstring

Reason recorded when the API key was revoked.

secretstring

API key secret value. Treat as high-privilege — do not log.

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/api-keys/{api_key_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "api_key_id": "ak_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Updated Clerk API key metadata.

updated_api_key.json

{
  "api_key": {
    "id": "ak_2abc123",
    "name": "server-integration",
    "subject": "user_2abc123",
    "description": "Updated integration key",
    "updated_at": 1710001000000
  }
}

PATCH/v1/clerk/domains/{domain_id}

https://api.vee3.io/v1/clerk/domains/{domain_id}

8 tokens

Update a custom domain on 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.update_domain

Parameters4 fields

clerk_instance_idstringOptional

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

domain_idstringRequired

Clerk organization domain id (dmn_...) to update, delete, or verify.

namestringOptional

Updated domain hostname.

proxy_urlstringOptional

Updated proxy URL for a satellite domain.

Response13 fields

domainobject

12 fields

Updated Clerk domain from the Backend API.

objectstring

Clerk object type for the domain.

idstring

Clerk domain id.

namestring

Domain hostname.

is_satelliteboolean

Whether this is a satellite domain.

frontend_api_urlstring

Frontend API URL for the domain.

accounts_portal_urlstring

Accounts portal URL for the domain.

proxy_urlstring

Proxy URL when using a satellite domain behind a reverse proxy.

development_originstring

Development origin associated with the domain.

cname_targetsarrayitems

3 fields

CNAME records required to verify the domain.

hoststring

DNS host label for the CNAME record.

valuestring

DNS target value for the CNAME record.

requiredboolean

Whether this CNAME record is required for domain verification.

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/domains/{domain_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "domain_id": "dmn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Custom domain after update.

updated_domain.json

{
  "domain": {
    "object": "domain",
    "id": "dmn_2abc123",
    "name": "auth.example.com",
    "is_satellite": false,
    "frontend_api_url": "https://clerk.example.com",
    "accounts_portal_url": "https://accounts.example.com",
    "proxy_url": null,
    "development_origin": null,
    "cname_targets": [
      {
        "host": "clerk",
        "value": "frontend-api.clerk.services",
        "required": true
      }
    ]
  }
}

PATCH/v1/clerk/email-addresses/{email_address_id}

https://api.vee3.io/v1/clerk/email-addresses/{email_address_id}

8 tokens

Update a Clerk email address (e.g. set as primary or verified).

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

Parameters4 fields

clerk_instance_idstringOptional

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

email_address_idstringRequired

Clerk email address id (idn_...) to retrieve or modify.

verifiedbooleanOptional

When true, mark the email address as verified.

primarybooleanOptional

When true, set this email as the user's primary email address.

Response9 fields

email_addressobject

8 fields

Updated Clerk email address summary.

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

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/email-addresses/{email_address_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "email_address_id": "idn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk email address after update.

updated_email_address.json

{
  "email_address": {
    "id": "idn_2abc123",
    "user_id": "user_2abc123",
    "email_address": "ada@example.com",
    "verification_status": "verified",
    "verified": true,
    "primary": true,
    "created_at": 1710000000000,
    "updated_at": 1710086400000
  }
}

PATCH/v1/clerk/enterprise-connections/{connection_id}

https://api.vee3.io/v1/clerk/enterprise-connections/{connection_id}

8 tokens

Update an enterprise SSO connection in a connected Clerk application.

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

Parameters12 fields

clerk_instance_idstringOptional

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

connection_idstringRequired

Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.

namestringOptional

Updated display name for the connection.

domainsarrayOptional

Updated domain list (replaces existing domains when provided).

activebooleanOptional

Whether the connection is active.

sync_user_attributesbooleanOptional

Whether to sync user attributes on each sign-in.

disable_additional_identificationsbooleanOptional

Whether to block additional identifications for this connection.

allow_organization_account_linkingbooleanOptional

Whether account linking via organization membership is allowed.

organization_idstringOptional

Clerk organization id (org_...) to link to this connection.

samlobjectOptional

Updated SAML IdP configuration.

oidcobjectOptional

Updated OIDC client configuration.

custom_attributesarrayOptional

Updated custom attribute mappings.

Response36 fields

enterprise_connectionobject

35 fields

Updated enterprise SSO connection.

idstring

Enterprise connection id.

namestring

Display name for the connection.

providerstring

Identity provider key (for example saml_custom or oidc_custom).

activeboolean

Whether the connection is active.

domainsstring[]

Email domains that may use this connection.

created_atinteger

Unix timestamp in milliseconds when the connection was created.

updated_atinteger

Unix timestamp in milliseconds when the connection was last updated.

logo_public_urlstring

Public logo URL for the connection when available.

organization_idstring

Linked Clerk organization id (org_...) when the connection is org-scoped.

sync_user_attributesboolean

Whether user attributes sync on each sign-in.

disable_additional_identificationsboolean

Whether users may add additional identifications with this connection.

allow_organization_account_linkingboolean

Whether account linking via organization membership is supported.

custom_attributesarrayitems

5 fields

Custom attribute mappings from the IdP to user metadata.

namestring

Display name for the custom attribute.

keystring

Metadata key used to store the attribute on the user.

sso_pathstring

Path to extract the value from SSO claims.

scim_pathstring

GJSON path to extract the value from SCIM resources.

multi_valuedboolean

Whether the attribute supports multiple values.

saml_connectionobject

9 fields

SAML configuration when the connection uses SAML.

idstring

SAML connection id when the connection uses SAML.

namestring

SAML connection display name.

idp_entity_idstring

Identity Provider entity id.

idp_sso_urlstring

Identity Provider Single Sign-On URL.

acs_urlstring

Assertion Consumer Service URL.

sp_entity_idstring

Service Provider entity id (Clerk).

activeboolean

Whether the SAML connection is active.

allow_idp_initiatedboolean

Whether IdP-initiated SSO is allowed.

allow_subdomainsboolean

Whether email subdomains may use this connection.

oauth_configobject

6 fields

OIDC configuration when the connection uses OAuth.

idstring

OAuth config id when the connection uses OIDC.

namestring

Custom OIDC provider display name.

provider_keystring

OAuth provider key (for example oidc_custom).

client_idstring

OAuth client id.

discovery_urlstring

OIDC discovery URL.

requires_pkceboolean

Whether PKCE is required for this OAuth client.

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/enterprise-connections/{connection_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "connection_id": "conn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200An updated enterprise SSO connection.

updated_enterprise_connection.json

{
  "enterprise_connection": {
    "id": "entc_2abc123",
    "name": "Acme SAML",
    "provider": "saml_custom",
    "active": true,
    "domains": [
      "acme.com"
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "sync_user_attributes": true,
    "disable_additional_identifications": false,
    "allow_organization_account_linking": false,
    "saml_connection": {
      "id": "saml_2abc123",
      "name": "Acme SAML",
      "idp_entity_id": "https://idp.acme.com",
      "idp_sso_url": "https://idp.acme.com/sso",
      "acs_url": "https://clerk.example.com/v1/saml/acs",
      "sp_entity_id": "https://clerk.example.com",
      "active": true,
      "allow_idp_initiated": false,
      "allow_subdomains": false
    }
  }
}

PATCH/v1/clerk/instance-communication-settings

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

8 tokens

Update 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.update_instance_communication_settings

Parameters2 fields

clerk_instance_idstringOptional

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

blocked_country_codesarrayOptional

ISO country codes to block from receiving SMS messages (up to 250).

Response3 fields

communication_settingsobject

2 fields

Updated 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",
}
payload = {
    "blocked_country_codes": ["US"]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Communication settings after update.

updated_communication_settings.json

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

PATCH/v1/clerk/instance-oauth-settings

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

8 tokens

Update OAuth 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.update_instance_oauth_settings

Parameters3 fields

clerk_instance_idstringOptional

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

dynamic_oauth_client_registrationbooleanOptional

Whether dynamic OAuth client registration should be enabled.

oauth_jwt_access_tokensbooleanOptional

Whether OAuth access tokens should be issued as JWTs.

Response4 fields

oauth_settingsobject

3 fields

Updated Clerk instance OAuth settings from the Backend API.

objectstring

Clerk object type for OAuth settings.

dynamic_oauth_client_registrationboolean

Whether dynamic OAuth client registration is enabled.

oauth_jwt_access_tokensboolean

Whether OAuth access tokens are issued as JWTs.

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-oauth-settings"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "dynamic_oauth_client_registration": False,
    "oauth_jwt_access_tokens": False
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200OAuth settings after update.

updated_oauth_settings.json

{
  "oauth_settings": {
    "object": "instance_oauth_settings",
    "dynamic_oauth_client_registration": true,
    "oauth_jwt_access_tokens": false
  }
}

PATCH/v1/clerk/instance-organization-settings

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

8 tokens

Update 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.update_instance_organization_settings

Parameters9 fields

clerk_instance_idstringOptional

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

enabledbooleanOptional

Whether organizations should be enabled for the instance.

max_allowed_membershipsintegerOptional

Maximum organization memberships allowed per user.

creator_rolestringOptional

Default role assigned to the organization creator.

admin_delete_enabledbooleanOptional

Whether organization admins can delete their organization.

domains_enabledbooleanOptional

Whether organization domains should be enabled.

domains_enrollment_modesarrayOptional

Allowed organization domain enrollment modes: manual_invitation, automatic_invitation, or automatic_suggestion.

domains_default_rolestringOptional

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

initial_role_set_keystringOptional

Initial role set key applied to new organizations.

Response15 fields

organization_settingsobject

14 fields

Updated 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",
}
payload = {
    "admin_delete_enabled": False,
    "creator_role": "example",
    "domains_default_role": "example"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization settings after update.

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

PATCH/v1/clerk/instance-restrictions

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

8 tokens

Update sign-up and sign-in restriction 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.update_instance_restrictions

Parameters6 fields

clerk_instance_idstringOptional

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

allowlistbooleanOptional

Whether the allowlist restriction should be enabled.

blocklistbooleanOptional

Whether the blocklist restriction should be enabled.

allowlist_blocklist_disabled_on_sign_inbooleanOptional

Whether allowlist and blocklist checks should be skipped during sign-in.

block_email_subaddressesbooleanOptional

Whether email subaddresses (plus-addressing) should be blocked.

block_disposable_email_domainsbooleanOptional

Whether disposable email domains should be blocked.

Response7 fields

restrictionsobject

6 fields

Updated Clerk instance restrictions from the Backend API.

objectstring

Clerk object type for instance restrictions.

allowlistboolean

Whether the allowlist restriction is enabled.

blocklistboolean

Whether the blocklist restriction is enabled.

allowlist_blocklist_disabled_on_sign_inboolean

Whether allowlist and blocklist checks are skipped during sign-in.

block_email_subaddressesboolean

Whether email subaddresses (plus-addressing) are blocked.

block_disposable_email_domainsboolean

Whether disposable email domains are blocked.

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-restrictions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "allowlist": False,
    "allowlist_blocklist_disabled_on_sign_in": False,
    "block_disposable_email_domains": False
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Instance restrictions after update.

updated_restrictions.json

{
  "restrictions": {
    "object": "instance_restrictions",
    "allowlist": true,
    "blocklist": false,
    "allowlist_blocklist_disabled_on_sign_in": false,
    "block_email_subaddresses": true,
    "block_disposable_email_domains": true
  }
}

PATCH/v1/clerk/instance-settings

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

8 tokens

Update 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.update_instance_settings

Parameters9 fields

clerk_instance_idstringOptional

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

test_modebooleanOptional

Whether the instance should run in test mode.

hibpbooleanOptional

Whether Have I Been Pwned password checking should be enabled.

support_emailstringOptional

Support email address shown to end users.

clerk_js_versionstringOptional

Pinned Clerk.js version for the instance.

development_originstringOptional

Development origin URL for local testing.

allowed_originsarrayOptional

Allowed browser origins for the instance.

url_based_session_syncingbooleanOptional

Whether URL-based session syncing should be enabled.

preferred_sign_in_strategy_when_password_requiredstringOptional

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

Response12 fields

instance_settingsobject

11 fields

Updated 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",
}
payload = {
    "allowed_origins": ["https://auth.example.com"],
    "clerk_js_version": "example",
    "development_origin": "example"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Instance settings after update.

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

PATCH/v1/clerk/jwt-templates/{template_id}

https://api.vee3.io/v1/clerk/jwt-templates/{template_id}

8 tokens

Update an existing JWT template in a connected Clerk application.

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

Parameters9 fields

clerk_instance_idstringOptional

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

template_idstringRequired

Clerk JWT template id (jtmp_...) to retrieve, update, or delete.

namestringOptional

Optional new unique template name.

claimsobjectOptional

Optional new JWT claims template as a JSON object.

lifetimeintegerOptional

Optional new token lifetime in seconds (30–315360000).

min 30, max 315360000

allowed_clock_skewintegerOptional

Optional new allowed clock skew in seconds (0–300).

min 0, max 300

custom_signing_keybooleanOptional

Optional flag to enable or disable a custom signing key.

signing_algorithmstringOptional

Optional custom signing algorithm.

signing_keystringOptional

Optional custom signing private key.

Response12 fields

jwt_templateobject

11 fields

Updated Clerk JWT template summary.

idstring

Clerk JWT template id (jtmp_...).

namestring

Unique template name used when minting tokens from this template.

claimsobject

2 fields

JWT claims template as a JSON object (may include Clerk shortcodes).

audstring

Audience claim when set in the template.

rolestring

Role claim when set in the template.

lifetimeinteger

Token lifetime in seconds (exp claim offset from issuance time).

allowed_clock_skewinteger

Allowed clock skew in seconds for the nbf claim.

created_atinteger

Unix timestamp in milliseconds when the template was created.

updated_atinteger

Unix timestamp in milliseconds when the template was last updated.

signing_algorithmstring

Custom signing algorithm when custom_signing_key is enabled.

custom_signing_keyboolean

Whether this template uses a custom signing key and algorithm.

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/jwt-templates/{template_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "template_id": "jtmp_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A Clerk JWT template after an update.

updated_jwt_template.json

{
  "jwt_template": {
    "id": "jtmp_2abc123",
    "name": "supabase-v2",
    "claims": {
      "aud": "authenticated",
      "role": "authenticated"
    },
    "lifetime": 7200,
    "allowed_clock_skew": 5,
    "created_at": 1710000000000,
    "updated_at": 1710100000000,
    "signing_algorithm": null,
    "custom_signing_key": false
  }
}

PATCH/v1/clerk/machines/{machine_id}

https://api.vee3.io/v1/clerk/machines/{machine_id}

8 tokens

Update a machine's name or default token TTL in 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.update_machine

Parameters4 fields

clerk_instance_idstringOptional

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

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

namestringOptional

Updated machine display name.

default_token_ttlintegerOptional

Updated default M2M token lifetime in seconds.

min 1, max 315360000

Response8 fields

machineobject

7 fields

Updated machine object from the Backend API.

idstring

Machine id (mch_...).

namestring

Machine display name.

instance_idstring

Clerk instance id (ins_...) that owns the machine.

default_token_ttlinteger

Default token lifetime in seconds for tokens created by this machine.

secret_keystring

Machine secret key returned on create. Treat as high-privilege — do not log.

created_atinteger

Unix timestamp in milliseconds when the machine was created.

updated_atinteger

Unix timestamp in milliseconds when the machine was last updated.

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/machines/{machine_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "machine_id": "mch_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk machine after an update.

updated_machine.json

{
  "machine": {
    "id": "mch_2abc123",
    "name": "billing-service-v2",
    "instance_id": "ins_2abc123",
    "default_token_ttl": 7200,
    "created_at": 1710000000000,
    "updated_at": 1710100000000
  }
}

PATCH/v1/clerk/oauth-applications/{oauth_application_id}

https://api.vee3.io/v1/clerk/oauth-applications/{oauth_application_id}

8 tokens

Update an OAuth application in a connected Clerk application.

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

Parameters7 fields

clerk_instance_idstringOptional

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

oauth_application_idstringRequired

Clerk OAuth application id (oa_...) to retrieve, update, or delete.

namestringOptional

New display name for the OAuth application.

redirect_urisarrayOptional

Replacement list of allowed redirect URIs.

scopesstringOptional

Space-delimited scopes (e.g. profile email public_metadata).

consent_screen_enabledbooleanOptional

Whether to show the OAuth consent screen during authorization.

publicbooleanOptional

Whether this is a public OAuth client (no client secret; PKCE-capable).

Response19 fields

oauth_applicationobject

18 fields

Updated Clerk OAuth application summary.

idstring

OAuth application id (oa_...).

namestring

OAuth application display name.

client_idstring

OAuth client id issued to authorized clients.

client_secretstring

OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.

client_image_urlstring

URL of the OAuth application logo when set.

client_uristring

Homepage URI for the OAuth client.

redirect_urisstring[]

Allowed redirect URIs for the OAuth authorization flow.

scopesstring

Space-delimited scopes granted by this OAuth application.

consent_screen_enabledboolean

Whether the consent screen is shown during authorization.

publicboolean

Whether this is a public OAuth client (PKCE-capable, no client secret).

pkce_requiredboolean

Whether PKCE is required for the authorization flow.

dynamically_registeredboolean

Whether the OAuth application was registered dynamically.

instance_idstring

Clerk instance id (ins_...) that owns this OAuth application.

authorize_urlstring

Authorization endpoint URL for this OAuth application.

token_fetch_urlstring

Token endpoint URL for exchanging authorization codes.

discovery_urlstring

OpenID Connect discovery document URL.

created_atinteger

Unix timestamp in milliseconds when the OAuth application was created.

updated_atinteger

Unix timestamp in milliseconds when the OAuth application was last updated.

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/oauth-applications/{oauth_application_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "oauth_application_id": "oa_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200An updated Clerk OAuth application.

updated_oauth_application.json

{
  "oauth_application": {
    "id": "oa_2abc123",
    "name": "My OAuth App v2",
    "client_id": "client_2abc123",
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "scopes": "profile email",
    "public": false,
    "created_at": 1710000000000,
    "updated_at": 1710100000000
  }
}

PATCH/v1/clerk/organizations/{organization_id}

https://api.vee3.io/v1/clerk/organizations/{organization_id}

8 tokens

Update fields for a Clerk organization.

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

Parameters7 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

namestringOptional

Optional new display name for the organization.

slugstringOptional

Optional new URL-friendly slug.

max_allowed_membershipsintegerOptional

Optional new maximum number of memberships allowed.

public_metadataobjectOptional

Optional public metadata to merge into the organization.

private_metadataobjectOptional

Optional private metadata to merge into the organization.

Response6 fields

organizationobject

5 fields

Updated Clerk organization summary.

idstring

Clerk organization id (org_...).

namestring

Organization display name.

slugstring

URL-friendly organization slug, if set.

members_countinteger

Current number of members in the organization.

created_atinteger

Unix timestamp in milliseconds when the organization was created.

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/organizations/{organization_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A Clerk organization after an update.

updated_organization.json

{
  "organization": {
    "id": "org_2abc123",
    "name": "Acme Corp (New)",
    "slug": "acme-corp-new",
    "members_count": 12,
    "created_at": 1710000000000
  }
}

PATCH/v1/clerk/organization-domains/{domain_id}

https://api.vee3.io/v1/clerk/organization-domains/{domain_id}

8 tokens

Update enrollment mode or verification status for an organization domain.

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

Parameters4 fields

clerk_instance_idstringOptional

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

domain_idstringRequired

Clerk organization domain id (dmn_...) to update, delete, or verify.

enrollment_modestringOptional

Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

verifiedbooleanOptional

Whether the domain is verified.

Response12 fields

domainobject

11 fields

Updated organization domain summary.

idstring

Clerk organization domain id (dmn_...).

namestring

Domain name (for example example.com).

organization_idstring

Clerk organization id (org_...) that owns this domain.

enrollment_modestring

Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

affiliation_email_addressstring

Affiliation email address for the domain, when set.

ownership_verification_statusstring

DNS ownership verification status (unverified, verified, failed, or expired).

affiliation_verification_statusstring

Affiliation verification status (unverified, verified, failed, or expired).

total_pending_invitationsinteger

Number of pending invitations associated with this domain.

total_pending_suggestionsinteger

Number of pending membership suggestions associated with this domain.

created_atinteger

Unix timestamp in milliseconds when the domain was created.

updated_atinteger

Unix timestamp in milliseconds when the domain was last updated.

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/organization-domains/{domain_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "domain_id": "dmn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization domain after update.

updated_domain.json

{
  "domain": {
    "id": "dmn_2abc123",
    "name": "example.com",
    "organization_id": "org_2xyz456",
    "enrollment_mode": "automatic_invitation",
    "affiliation_email_address": null,
    "ownership_verification_status": "verified",
    "affiliation_verification_status": "verified",
    "total_pending_invitations": 0,
    "total_pending_suggestions": 0,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

PATCH/v1/clerk/organizations/{organization_id}/memberships/{user_id}

https://api.vee3.io/v1/clerk/organizations/{organization_id}/memberships/{user_id}

8 tokens

Change the role of a member in an organization in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) containing the member.

user_idstringRequired

Clerk user id (user_...) of the member to update.

rolestringRequired

New role for the member (e.g. org:member, org:admin).

Response5 fields

membershipobject

4 fields

Updated organization membership.

idstring

Clerk organization membership id (orgmem_...).

user_idstring

Clerk user id (user_...) of the member.

rolestring

Role of the member in the organization (e.g. org:admin, org:member).

created_atinteger

Unix timestamp in milliseconds when the membership was created.

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/organizations/{organization_id}/memberships/{user_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789",
    "user_id": "user_2abc123",
    "role": "org:member"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Updated organization membership with new role.

updated_membership.json

{
  "membership": {
    "id": "orgmem_2abc123",
    "user_id": "user_2abc123",
    "role": "org:admin",
    "created_at": 1710000000000
  }
}

PATCH/v1/clerk/organizations/{organization_id}/memberships/{user_id}/metadata

https://api.vee3.io/v1/clerk/organizations/{organization_id}/memberships/{user_id}/metadata

8 tokens

Merge metadata on an organization membership in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) containing the membership.

user_idstringRequired

Clerk user id (user_...) of the member.

public_metadataobjectOptional

Public metadata to merge into the membership.

private_metadataobjectOptional

Private metadata to merge into the membership.

Response5 fields

membershipobject

4 fields

Updated organization membership.

idstring

Clerk organization membership id (orgmem_...).

user_idstring

Clerk user id (user_...) of the member.

rolestring

Role of the member in the organization (e.g. org:admin, org:member).

created_atinteger

Unix timestamp in milliseconds when the membership was created.

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/organizations/{organization_id}/memberships/{user_id}/metadata"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789",
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization membership after metadata merge.

updated_membership_metadata.json

{
  "membership": {
    "id": "orgmem_2abc123",
    "user_id": "user_2abc123",
    "role": "org:member",
    "created_at": 1710000000000
  }
}

PATCH/v1/clerk/organizations/{organization_id}/metadata

https://api.vee3.io/v1/clerk/organizations/{organization_id}/metadata

8 tokens

Merge metadata into a Clerk organization.

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

Parameters4 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

public_metadataobjectOptional

Public metadata to merge into the organization.

private_metadataobjectOptional

Private metadata to merge into the organization.

Response6 fields

organizationobject

5 fields

Updated Clerk organization summary.

idstring

Clerk organization id (org_...).

namestring

Organization display name.

slugstring

URL-friendly organization slug, if set.

members_countinteger

Current number of members in the organization.

created_atinteger

Unix timestamp in milliseconds when the organization was created.

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/organizations/{organization_id}/metadata"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization after a metadata merge.

updated_metadata.json

{
  "organization": {
    "id": "org_2abc123",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "members_count": 12,
    "created_at": 1710000000000
  }
}

PATCH/v1/clerk/organization-permissions/{permission_id}

https://api.vee3.io/v1/clerk/organization-permissions/{permission_id}

8 tokens

Update an organization permission in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

permission_idstringRequired

Clerk organization permission id to retrieve, update, delete, or assign to a role.

namestringOptional

Updated permission display name.

descriptionstringOptional

Updated permission description.

Response8 fields

organization_permissionobject

7 fields

Updated organization permission summary.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

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/organization-permissions/{permission_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "permission_id": "orgperm_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200An updated organization permission.

updated_organization_permission.json

{
  "organization_permission": {
    "id": "orgperm_2abc123",
    "name": "Manage billing",
    "key": "org:sys_billing:manage",
    "description": "Manage organization billing",
    "type": "system",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

PATCH/v1/clerk/organization-roles/{role_id}

https://api.vee3.io/v1/clerk/organization-roles/{role_id}

8 tokens

Update an organization role in a connected Clerk application.

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

Parameters6 fields

clerk_instance_idstringOptional

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

role_idstringRequired

Clerk organization role id to retrieve, update, delete, or assign permissions to.

namestringOptional

Updated role display name.

descriptionstringOptional

Updated role description.

is_creator_eligiblebooleanOptional

Whether this role may be assigned as organization creator.

permissionsarrayOptional

Permission keys to assign to the role.

Response16 fields

organization_roleobject

15 fields

Updated organization role summary.

idstring

Clerk organization role id.

namestring

Role display name.

keystring

Role key used in memberships.

descriptionstring

Role description.

is_creator_eligibleboolean

Whether this role may be assigned as organization creator.

permissionsarrayitems

7 fields

Permissions assigned to this role.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

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/organization-roles/{role_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "role_id": "orgrole_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200An updated organization role.

updated_organization_role.json

{
  "organization_role": {
    "id": "orgrl_2abc123",
    "name": "Admin",
    "key": "org:admin",
    "description": "Organization administrator",
    "is_creator_eligible": true,
    "permissions": [
      {
        "id": "orgperm_2abc123",
        "name": "Manage billing",
        "key": "org:sys_billing:manage",
        "description": "Manage organization billing",
        "type": "system",
        "created_at": 1710000000000,
        "updated_at": 1710000000000
      }
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

PATCH/v1/clerk/phone-numbers/{phone_number_id}

https://api.vee3.io/v1/clerk/phone-numbers/{phone_number_id}

8 tokens

Update a Clerk phone number.

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

Parameters5 fields

clerk_instance_idstringOptional

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

phone_number_idstringRequired

Clerk phone number id (idn_... or phn_...) to retrieve or modify.

verifiedbooleanOptional

Whether the phone number should be marked verified.

primarybooleanOptional

Whether this should be the user's primary phone number.

reserved_for_second_factorbooleanOptional

Whether to reserve this number for multi-factor authentication.

Response6 fields

phone_numberobject

5 fields

Updated Clerk phone number object from the Backend API.

idstring

Clerk phone number id.

phone_numberstring

Phone number in E.164 format.

verifiedboolean

Whether the phone number is verified.

reserved_for_second_factorboolean

Whether the phone number is reserved for multi-factor authentication.

default_second_factorboolean

Whether this is the user's default second factor.

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/phone-numbers/{phone_number_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "phone_number_id": "phn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Updated Clerk phone number.

phone_number_updated.json

{
  "phone_number": {
    "id": "idn_2abc123",
    "phone_number": "+15551234567",
    "verified": true,
    "reserved_for_second_factor": false,
    "default_second_factor": false
  }
}

PATCH/v1/clerk/role-sets/{role_set_id}

https://api.vee3.io/v1/clerk/role-sets/{role_set_id}

8 tokens

Update a role set in a connected Clerk application.

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

Parameters6 fields

clerk_instance_idstringOptional

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

role_set_idstringRequired

Clerk role set id or key to retrieve, update, or modify.

namestringOptional

Updated role set display name.

descriptionstringOptional

Updated role set description.

default_role_keystringOptional

Updated default role key.

creator_role_keystringOptional

Updated creator role key.

Response35 fields

role_setobject

34 fields

Updated role set summary.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems

8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject

8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject

8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

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/role-sets/{role_set_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "role_set_id": "orgroleset_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200An updated role set.

updated_role_set.json

{
  "role_set": {
    "id": "rs_2abc123",
    "name": "Default",
    "key": "default",
    "description": "Default organization roles",
    "roles": [
      {
        "id": "orgrl_2member",
        "name": "Member",
        "key": "org:member",
        "description": "Organization member",
        "created_at": 1710000000000,
        "updated_at": 1710000000000,
        "members_count": 42,
        "has_members": true
      }
    ],
    "default_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "creator_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "type": "default",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

PATCH/v1/clerk/sign-ups/{sign_up_id}

https://api.vee3.io/v1/clerk/sign-ups/{sign_up_id}

8 tokens

Update an in-progress sign-up in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

sign_up_idstringRequired

Clerk sign-up id (su_...) to retrieve or update.

external_idstringOptional

External id for the guest signing up; copied to the user when sign-up completes.

custom_actionbooleanOptional

When true, marks the sign-up as a custom action.

Response12 fields

idstring

Clerk sign-up id (su_...).

statusstring

Sign-up status: "missing_requirements", "complete", or "abandoned".

email_addressstring

Email address associated with the in-progress sign-up.

phone_numberstring

Phone number associated with the in-progress sign-up.

usernamestring

Username associated with the in-progress sign-up.

first_namestring

First name collected during sign-up.

last_namestring

Last name collected during sign-up.

missing_fieldsstring[]

Fields still required before the sign-up can complete.

unverified_fieldsstring[]

Fields that still need verification.

created_user_idstring

Clerk user id created when the sign-up completed.

created_session_idstring

Clerk session id created when the sign-up completed.

abandon_atinteger

Unix timestamp in milliseconds when the sign-up will be abandoned.

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/sign-ups/{sign_up_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "sign_up_id": "sign_up_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sign-up after updating external_id or custom_action.

updated_sign_up.json

{
  "id": "su_2abc123",
  "status": "missing_requirements",
  "email_address": "ada@example.com",
  "phone_number": null,
  "username": null,
  "first_name": "Ada",
  "last_name": "Lovelace",
  "missing_fields": [
    "password"
  ],
  "unverified_fields": [],
  "created_user_id": null,
  "created_session_id": null,
  "abandon_at": 1710086400000
}

PATCH/v1/clerk/users/{user_id}/metadata

https://api.vee3.io/v1/clerk/users/{user_id}/metadata

8 tokens

Merge metadata fields for a Clerk user.

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

Parameters5 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) whose metadata to update.

public_metadataobjectOptional

Public metadata fields to merge. Existing keys not listed are preserved.

private_metadataobjectOptional

Private metadata fields to merge. Existing keys not listed are preserved.

unsafe_metadataobjectOptional

Unsafe metadata fields to merge. Existing keys not listed are preserved.

Response6 fields

userobject

5 fields

Updated Clerk user object after the metadata merge.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}/metadata"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after a metadata merge.

updated_metadata_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}

POST/v1/clerk/oauth-applications/{oauth_application_id}/logo

https://api.vee3.io/v1/clerk/oauth-applications/{oauth_application_id}/logo

8 tokens

Upload or replace the logo for an OAuth application in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

oauth_application_idstringRequired

Clerk OAuth application id (oa_...) to retrieve, update, or delete.

file_namestringRequired

Stored file name from files.list_uploaded_files. Upload with files.upload_file first.

uploader_user_idstringOptional

Clerk user id (user_...) credited with the image upload.

Response19 fields

oauth_applicationobject

18 fields

OAuth application summary with updated client_image_url.

idstring

OAuth application id (oa_...).

namestring

OAuth application display name.

client_idstring

OAuth client id issued to authorized clients.

client_secretstring

OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.

client_image_urlstring

URL of the OAuth application logo when set.

client_uristring

Homepage URI for the OAuth client.

redirect_urisstring[]

Allowed redirect URIs for the OAuth authorization flow.

scopesstring

Space-delimited scopes granted by this OAuth application.

consent_screen_enabledboolean

Whether the consent screen is shown during authorization.

publicboolean

Whether this is a public OAuth client (PKCE-capable, no client secret).

pkce_requiredboolean

Whether PKCE is required for the authorization flow.

dynamically_registeredboolean

Whether the OAuth application was registered dynamically.

instance_idstring

Clerk instance id (ins_...) that owns this OAuth application.

authorize_urlstring

Authorization endpoint URL for this OAuth application.

token_fetch_urlstring

Token endpoint URL for exchanging authorization codes.

discovery_urlstring

OpenID Connect discovery document URL.

created_atinteger

Unix timestamp in milliseconds when the OAuth application was created.

updated_atinteger

Unix timestamp in milliseconds when the OAuth application was last updated.

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/oauth-applications/{oauth_application_id}/logo"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "oauth_application_id": "oa_2abc123",
    "file_name": "logo.png"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200OAuth application after logo upload.

oauth_application_with_logo.json

{
  "oauth_application": {
    "id": "oa_2abc123",
    "name": "My OAuth App",
    "client_image_url": "https://img.clerk.com/example.png",
    "created_at": 1710000000000,
    "updated_at": 1710100000000
  }
}

POST/v1/clerk/domains

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

10 tokens

Add a custom domain to 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.add_domain

Parameters4 fields

clerk_instance_idstringOptional

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

namestringRequired

Domain hostname to add.

is_satellitebooleanRequired

Whether this is a satellite domain.

proxy_urlstringOptional

Proxy URL when using a satellite domain behind a reverse proxy.

Response13 fields

domainobject

12 fields

Created Clerk domain from the Backend API.

objectstring

Clerk object type for the domain.

idstring

Clerk domain id.

namestring

Domain hostname.

is_satelliteboolean

Whether this is a satellite domain.

frontend_api_urlstring

Frontend API URL for the domain.

accounts_portal_urlstring

Accounts portal URL for the domain.

proxy_urlstring

Proxy URL when using a satellite domain behind a reverse proxy.

development_originstring

Development origin associated with the domain.

cname_targetsarrayitems

3 fields

CNAME records required to verify the domain.

hoststring

DNS host label for the CNAME record.

valuestring

DNS target value for the CNAME record.

requiredboolean

Whether this CNAME record is required for domain verification.

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/domains"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "is_satellite": False
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly added custom domain.

created_domain.json

{
  "domain": {
    "object": "domain",
    "id": "dmn_2abc123",
    "name": "auth.example.com",
    "is_satellite": false,
    "frontend_api_url": "https://clerk.example.com",
    "accounts_portal_url": "https://accounts.example.com",
    "proxy_url": null,
    "development_origin": null,
    "cname_targets": [
      {
        "host": "clerk",
        "value": "frontend-api.clerk.services",
        "required": true
      }
    ]
  }
}

POST/v1/clerk/invitations/bulk

https://api.vee3.io/v1/clerk/invitations/bulk

10 tokens

Invite multiple email addresses to sign up for a connected Clerk application in one request.

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

Parameters2 fields

clerk_instance_idstringOptional

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

invitationsstringRequired

JSON array of invitation objects. Each object requires "email_address" (string) and optionally "role" (string) and "redirect_url" (string). Example: [{"email_address": "user@example.com", "role": "org:member"}]

Response6 fields

invitationsarrayitems

5 fields

Created Clerk invitation objects from the Backend API.

idstring

Clerk invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

statusstring

Invitation status: "pending", "accepted", "revoked", or "expired".

created_atinteger

Unix timestamp in milliseconds when the invitation was created.

revokedboolean

Whether the invitation has been revoked.

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/invitations/bulk"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "invitations": [{"email_address":"ada@example.com","role":"org:member"}]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk invitations.

bulk_created_invitations.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "email_address": "ada@example.com",
      "status": "pending",
      "created_at": 1710000000000,
      "revoked": false
    },
    {
      "id": "inv_2def456",
      "email_address": "grace@example.com",
      "status": "pending",
      "created_at": 1710000000001,
      "revoked": false
    }
  ]
}

POST/v1/clerk/organizations/{organization_id}/invitations/bulk

https://api.vee3.io/v1/clerk/organizations/{organization_id}/invitations/bulk

10 tokens

Invite multiple email addresses to join a Clerk organization in one request.

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

Parameters3 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

invitationsarrayRequired

List of invitations to create. Each item requires email_address and role.

Response6 fields

invitationsarrayitems

5 fields

Created invitation summaries.

idstring

Clerk organization invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

rolestring

Role assigned to the invitee (e.g. org:admin, org:member).

statusstring

Invitation status: pending, accepted, or revoked.

organization_idstring

Clerk organization id (org_...) that owns this invitation.

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/organizations/{organization_id}/invitations/bulk"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "organization_id": "org_2xyz789",
    "invitations": [{"email_address":"ada@example.com","role":"org:member"}]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Bulk-created organization invitations.

bulk_created_invitations.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "email_address": "ada@example.com",
      "role": "org:member",
      "status": "pending",
      "organization_id": "org_2xyz456"
    }
  ]
}

POST/v1/clerk/waitlist-entries/bulk

https://api.vee3.io/v1/clerk/waitlist-entries/bulk

10 tokens

Add multiple email addresses to the waitlist in one request.

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

Parameters2 fields

clerk_instance_idstringOptional

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

waitlist_entriesstringRequired

JSON array of waitlist entry objects. Each object requires "email_address" (string) and optionally "notify" (boolean). Example: [{"email_address": "user@example.com", "notify": true}]

Response7 fields

waitlist_entriesarrayitems

6 fields

Created or existing Clerk waitlist entries from the Backend API.

idstring

Waitlist entry id (wle_...).

email_addressstring

Email address on the waitlist.

statusstring

Waitlist status: "pending", "invited", "rejected", or "completed".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

is_lockedboolean

Whether the entry is locked during batch processing.

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/waitlist-entries/bulk"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "waitlist_entries": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Bulk-created waitlist entries.

bulk_created_waitlist_entries.json

{
  "waitlist_entries": [
    {
      "id": "wle_2abc123",
      "email_address": "ada@example.com",
      "status": "pending",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "is_locked": false
    }
  ]
}

POST/v1/clerk/instance/change-domain

https://api.vee3.io/v1/clerk/instance/change-domain

10 tokens

Change the primary or secondary home URL 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.change_instance_domain

Parameters3 fields

clerk_instance_idstringOptional

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

home_urlstringRequired

New home URL for the instance domain.

is_secondarybooleanOptional

When true, change the secondary domain instead of the primary.

Response1 field

acceptedboolean

Whether Clerk accepted the domain change request.

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/change-domain"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "home_url": "https://auth.example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Domain change request accepted by Clerk.

domain_change_accepted.json

{
  "accepted": true
}

POST/v1/clerk/billing/prices

https://api.vee3.io/v1/clerk/billing/prices

10 tokens

Create a billing price for a plan in a connected Clerk application.

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

Parameters6 fields

clerk_instance_idstringOptional

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

plan_idstringRequired

Billing plan id to create a price for.

amountintegerRequired

Price amount in cents (minimum 100).

min 100

currencystringOptional

ISO currency code (for example usd).

annual_monthly_amountintegerOptional

Equivalent monthly amount in cents when billed annually (minimum 100).

min 100

descriptionstringOptional

Price description.

Response9 fields

billing_priceobject

8 fields

Created billing price summary.

idstring

Clerk billing price id.

plan_idstring

Billing plan id this price belongs to.

currencystring

ISO currency code (for example usd).

amountinteger

Price amount in cents.

annual_monthly_amountinteger

Equivalent monthly amount in cents when billed annually.

descriptionstring

Price description.

is_defaultboolean

Whether this is the default price for the plan.

created_atinteger

Unix timestamp in milliseconds when the price was created.

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/billing/prices"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "plan_id": "pln_2abc123",
    "amount": 1000
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created billing price.

created_billing_price.json

{
  "billing_price": {
    "id": "price_2abc123",
    "plan_id": "plan_2abc123",
    "currency": "usd",
    "amount": 2000,
    "annual_monthly_amount": 1500,
    "description": "Monthly Pro",
    "is_default": true,
    "created_at": 1710000000000
  }
}

POST/v1/clerk/email-addresses

https://api.vee3.io/v1/clerk/email-addresses

10 tokens

Create a new email address for a Clerk user.

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

Parameters5 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

email_addressstringRequired

Email address to create for the user.

verifiedbooleanOptional

When true, the email address is created as verified.

primarybooleanOptional

When true, set this email as the user's primary email address.

Response9 fields

email_addressobject

8 fields

Created Clerk email address summary.

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

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/email-addresses"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "email_address": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Email address created for a Clerk user.

created_email_address.json

{
  "email_address": {
    "id": "idn_2abc123",
    "user_id": "user_2abc123",
    "email_address": "ada@example.com",
    "verification_status": "unverified",
    "verified": false,
    "primary": false,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/enterprise-connections

https://api.vee3.io/v1/clerk/enterprise-connections

10 tokens

Create a SAML or OIDC enterprise SSO connection in a connected Clerk application.

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

Parameters12 fields

clerk_instance_idstringOptional

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

namestringRequired

Display name for the enterprise connection.

providerstringRequired

Identity provider key (for example saml_custom or oidc_custom).

domainsarrayRequired

Email domains that may use this connection.

organization_idstringOptional

Clerk organization id (org_...) to link to this connection.

activebooleanOptional

Whether the connection is active.

sync_user_attributesbooleanOptional

Whether to sync user attributes on each sign-in.

disable_additional_identificationsbooleanOptional

Whether to block additional identifications for this connection.

allow_organization_account_linkingbooleanOptional

Whether account linking via organization membership is allowed.

samlobjectOptional

SAML IdP configuration when provider uses SAML.

oidcobjectOptional

OIDC client configuration when provider uses OAuth.

custom_attributesarrayOptional

Custom attribute mappings from the IdP to user metadata.

Response36 fields

enterprise_connectionobject

35 fields

Newly created enterprise SSO connection.

idstring

Enterprise connection id.

namestring

Display name for the connection.

providerstring

Identity provider key (for example saml_custom or oidc_custom).

activeboolean

Whether the connection is active.

domainsstring[]

Email domains that may use this connection.

created_atinteger

Unix timestamp in milliseconds when the connection was created.

updated_atinteger

Unix timestamp in milliseconds when the connection was last updated.

logo_public_urlstring

Public logo URL for the connection when available.

organization_idstring

Linked Clerk organization id (org_...) when the connection is org-scoped.

sync_user_attributesboolean

Whether user attributes sync on each sign-in.

disable_additional_identificationsboolean

Whether users may add additional identifications with this connection.

allow_organization_account_linkingboolean

Whether account linking via organization membership is supported.

custom_attributesarrayitems

5 fields

Custom attribute mappings from the IdP to user metadata.

namestring

Display name for the custom attribute.

keystring

Metadata key used to store the attribute on the user.

sso_pathstring

Path to extract the value from SSO claims.

scim_pathstring

GJSON path to extract the value from SCIM resources.

multi_valuedboolean

Whether the attribute supports multiple values.

saml_connectionobject

9 fields

SAML configuration when the connection uses SAML.

idstring

SAML connection id when the connection uses SAML.

namestring

SAML connection display name.

idp_entity_idstring

Identity Provider entity id.

idp_sso_urlstring

Identity Provider Single Sign-On URL.

acs_urlstring

Assertion Consumer Service URL.

sp_entity_idstring

Service Provider entity id (Clerk).

activeboolean

Whether the SAML connection is active.

allow_idp_initiatedboolean

Whether IdP-initiated SSO is allowed.

allow_subdomainsboolean

Whether email subdomains may use this connection.

oauth_configobject

6 fields

OIDC configuration when the connection uses OAuth.

idstring

OAuth config id when the connection uses OIDC.

namestring

Custom OIDC provider display name.

provider_keystring

OAuth provider key (for example oidc_custom).

client_idstring

OAuth client id.

discovery_urlstring

OIDC discovery URL.

requires_pkceboolean

Whether PKCE is required for this OAuth client.

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/enterprise-connections"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "provider": "oauth_google",
    "domains": ["auth.example.com"]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A newly created enterprise SSO connection.

created_enterprise_connection.json

{
  "enterprise_connection": {
    "id": "entc_2abc123",
    "name": "Acme SAML",
    "provider": "saml_custom",
    "active": true,
    "domains": [
      "acme.com"
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "sync_user_attributes": true,
    "disable_additional_identifications": false,
    "allow_organization_account_linking": false,
    "saml_connection": {
      "id": "saml_2abc123",
      "name": "Acme SAML",
      "idp_entity_id": "https://idp.acme.com",
      "idp_sso_url": "https://idp.acme.com/sso",
      "acs_url": "https://clerk.example.com/v1/saml/acs",
      "sp_entity_id": "https://clerk.example.com",
      "active": true,
      "allow_idp_initiated": false,
      "allow_subdomains": false
    }
  }
}

POST/v1/clerk/jwt-templates

https://api.vee3.io/v1/clerk/jwt-templates

10 tokens

Create a new JWT template in a connected Clerk application.

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

Parameters8 fields

clerk_instance_idstringOptional

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

namestringRequired

Unique JWT template name.

claimsobjectRequired

JWT claims template as a JSON object.

lifetimeintegerOptional

Token lifetime in seconds (30–315360000).

min 30, max 315360000

allowed_clock_skewintegerOptional

Allowed clock skew in seconds (0–300).

min 0, max 300

custom_signing_keybooleanOptional

Whether to use a custom signing key and algorithm.

signing_algorithmstringOptional

Custom signing algorithm (required when custom_signing_key is true).

signing_keystringOptional

Custom signing private key (required when custom_signing_key is true).

Response12 fields

jwt_templateobject

11 fields

Newly created Clerk JWT template summary.

idstring

Clerk JWT template id (jtmp_...).

namestring

Unique template name used when minting tokens from this template.

claimsobject

2 fields

JWT claims template as a JSON object (may include Clerk shortcodes).

audstring

Audience claim when set in the template.

rolestring

Role claim when set in the template.

lifetimeinteger

Token lifetime in seconds (exp claim offset from issuance time).

allowed_clock_skewinteger

Allowed clock skew in seconds for the nbf claim.

created_atinteger

Unix timestamp in milliseconds when the template was created.

updated_atinteger

Unix timestamp in milliseconds when the template was last updated.

signing_algorithmstring

Custom signing algorithm when custom_signing_key is enabled.

custom_signing_keyboolean

Whether this template uses a custom signing key and algorithm.

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/jwt-templates"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "claims": {"role":"org:member"}
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A newly created Clerk JWT template.

created_jwt_template.json

{
  "jwt_template": {
    "id": "jtmp_2abc123",
    "name": "supabase",
    "claims": {
      "aud": "authenticated",
      "role": "authenticated"
    },
    "lifetime": 3600,
    "allowed_clock_skew": 5,
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "signing_algorithm": null,
    "custom_signing_key": false
  }
}

POST/v1/clerk/machines

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

10 tokens

Create a machine identity for M2M authentication in 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.create_machine

Parameters4 fields

clerk_instance_idstringOptional

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

namestringRequired

Machine display name (1–255 characters).

scoped_machinesarrayOptional

Machine ids (mch_...) this machine may access (max 150).

default_token_ttlintegerOptional

Default M2M token lifetime in seconds (minimum 1).

min 1, max 315360000

Response8 fields

machineobject

7 fields

Created machine object from the Backend API.

idstring

Machine id (mch_...).

namestring

Machine display name.

instance_idstring

Clerk instance id (ins_...) that owns the machine.

default_token_ttlinteger

Default token lifetime in seconds for tokens created by this machine.

secret_keystring

Machine secret key returned on create. Treat as high-privilege — do not log.

created_atinteger

Unix timestamp in milliseconds when the machine was created.

updated_atinteger

Unix timestamp in milliseconds when the machine was last updated.

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/machines"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk machine for M2M authentication.

created_machine.json

{
  "machine": {
    "id": "mch_2abc123",
    "name": "billing-service",
    "instance_id": "ins_2abc123",
    "default_token_ttl": 3600,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/oauth-applications

https://api.vee3.io/v1/clerk/oauth-applications

10 tokens

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

Parameters6 fields

clerk_instance_idstringOptional

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

namestringRequired

Display name for the new OAuth application.

redirect_urisarrayOptional

Allowed redirect URIs for the OAuth authorization flow.

scopesstringOptional

Space-delimited scopes (e.g. profile email public_metadata).

consent_screen_enabledbooleanOptional

Whether to show the OAuth consent screen during authorization.

publicbooleanOptional

Whether this is a public OAuth client (no client secret; PKCE-capable).

Response19 fields

oauth_applicationobject

18 fields

Newly created Clerk OAuth application summary.

idstring

OAuth application id (oa_...).

namestring

OAuth application display name.

client_idstring

OAuth client id issued to authorized clients.

client_secretstring

OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.

client_image_urlstring

URL of the OAuth application logo when set.

client_uristring

Homepage URI for the OAuth client.

redirect_urisstring[]

Allowed redirect URIs for the OAuth authorization flow.

scopesstring

Space-delimited scopes granted by this OAuth application.

consent_screen_enabledboolean

Whether the consent screen is shown during authorization.

publicboolean

Whether this is a public OAuth client (PKCE-capable, no client secret).

pkce_requiredboolean

Whether PKCE is required for the authorization flow.

dynamically_registeredboolean

Whether the OAuth application was registered dynamically.

instance_idstring

Clerk instance id (ins_...) that owns this OAuth application.

authorize_urlstring

Authorization endpoint URL for this OAuth application.

token_fetch_urlstring

Token endpoint URL for exchanging authorization codes.

discovery_urlstring

OpenID Connect discovery document URL.

created_atinteger

Unix timestamp in milliseconds when the OAuth application was created.

updated_atinteger

Unix timestamp in milliseconds when the OAuth application was last updated.

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/oauth-applications"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A newly created Clerk OAuth application.

created_oauth_application.json

{
  "oauth_application": {
    "id": "oa_2abc123",
    "name": "My OAuth App",
    "client_id": "client_2abc123",
    "client_secret": "secret_value",
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "scopes": "profile email",
    "public": false,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/organizations/{organization_id}/domains

https://api.vee3.io/v1/clerk/organizations/{organization_id}/domains

10 tokens

Add a verified domain to a Clerk organization.

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

Parameters5 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

namestringRequired

Domain name to add (for example example.com).

enrollment_modestringOptional

Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

verifiedbooleanOptional

Whether the domain is verified. Defaults to true when omitted.

Response12 fields

domainobject

11 fields

Created organization domain summary.

idstring

Clerk organization domain id (dmn_...).

namestring

Domain name (for example example.com).

organization_idstring

Clerk organization id (org_...) that owns this domain.

enrollment_modestring

Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

affiliation_email_addressstring

Affiliation email address for the domain, when set.

ownership_verification_statusstring

DNS ownership verification status (unverified, verified, failed, or expired).

affiliation_verification_statusstring

Affiliation verification status (unverified, verified, failed, or expired).

total_pending_invitationsinteger

Number of pending invitations associated with this domain.

total_pending_suggestionsinteger

Number of pending membership suggestions associated with this domain.

created_atinteger

Unix timestamp in milliseconds when the domain was created.

updated_atinteger

Unix timestamp in milliseconds when the domain was last updated.

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/organizations/{organization_id}/domains"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "organization_id": "org_2xyz789",
    "name": "billing-service"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created organization domain.

created_domain.json

{
  "domain": {
    "id": "dmn_2abc123",
    "name": "example.com",
    "organization_id": "org_2xyz456",
    "enrollment_mode": "automatic_invitation",
    "affiliation_email_address": null,
    "ownership_verification_status": "verified",
    "affiliation_verification_status": "verified",
    "total_pending_invitations": 0,
    "total_pending_suggestions": 0,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/organizations/{organization_id}/memberships

https://api.vee3.io/v1/clerk/organizations/{organization_id}/memberships

10 tokens

Add a user to an organization in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to add the member to.

user_idstringRequired

Clerk user id (user_...) of the user to add.

rolestringRequired

Role to assign to the user in the organization (e.g. org:member, org:admin).

Response5 fields

membershipobject

4 fields

Created organization membership.

idstring

Clerk organization membership id (orgmem_...).

user_idstring

Clerk user id (user_...) of the member.

rolestring

Role of the member in the organization (e.g. org:admin, org:member).

created_atinteger

Unix timestamp in milliseconds when the membership was created.

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/organizations/{organization_id}/memberships"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "organization_id": "org_2xyz789",
    "user_id": "user_2abc123",
    "role": "org:member"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created organization membership.

created_membership.json

{
  "membership": {
    "id": "orgmem_2abc123",
    "user_id": "user_2abc123",
    "role": "org:member",
    "created_at": 1710000000000
  }
}

POST/v1/clerk/organization-permissions

https://api.vee3.io/v1/clerk/organization-permissions

10 tokens

Create a new organization permission in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

namestringRequired

Permission display name.

keystringRequired

Unique permission key.

descriptionstringOptional

Permission description.

Response8 fields

organization_permissionobject

7 fields

Newly created organization permission summary.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

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/organization-permissions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "key": "billing_service"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A newly created organization permission.

created_organization_permission.json

{
  "organization_permission": {
    "id": "orgperm_2abc123",
    "name": "Manage billing",
    "key": "org:sys_billing:manage",
    "description": "Manage organization billing",
    "type": "system",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/organization-roles

https://api.vee3.io/v1/clerk/organization-roles

10 tokens

Create a new organization role in a connected Clerk application.

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

Parameters6 fields

clerk_instance_idstringOptional

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

namestringRequired

Role display name.

keystringRequired

Unique role key.

descriptionstringOptional

Role description.

permissionsarrayOptional

Permission keys to assign to the new role.

include_in_initial_role_setbooleanOptional

Whether to include this role in the initial role set.

Response16 fields

organization_roleobject

15 fields

Newly created organization role summary.

idstring

Clerk organization role id.

namestring

Role display name.

keystring

Role key used in memberships.

descriptionstring

Role description.

is_creator_eligibleboolean

Whether this role may be assigned as organization creator.

permissionsarrayitems

7 fields

Permissions assigned to this role.

idstring

Clerk organization permission id.

namestring

Permission display name.

keystring

Permission key used in role assignments.

descriptionstring

Permission description.

typestring

Permission type (system or custom).

created_atinteger

Unix timestamp in milliseconds when the permission was created.

updated_atinteger

Unix timestamp in milliseconds when the permission was last updated.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

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/organization-roles"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "key": "billing_service"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A newly created organization role.

created_organization_role.json

{
  "organization_role": {
    "id": "orgrl_2abc123",
    "name": "Admin",
    "key": "org:admin",
    "description": "Organization administrator",
    "is_creator_eligible": true,
    "permissions": [
      {
        "id": "orgperm_2abc123",
        "name": "Manage billing",
        "key": "org:sys_billing:manage",
        "description": "Manage organization billing",
        "type": "system",
        "created_at": 1710000000000,
        "updated_at": 1710000000000
      }
    ],
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/phone-numbers

https://api.vee3.io/v1/clerk/phone-numbers

10 tokens

Create a phone number for a Clerk user.

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

Parameters6 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

phone_numberstringRequired

Phone number in E.164 format (e.g. +15551234567).

verifiedbooleanOptional

Whether the phone number should be marked verified. Defaults to false.

primarybooleanOptional

Whether this should be the user's primary phone number.

reserved_for_second_factorbooleanOptional

Whether to reserve this number for multi-factor authentication.

Response6 fields

phone_numberobject

5 fields

Created Clerk phone number object from the Backend API.

idstring

Clerk phone number id.

phone_numberstring

Phone number in E.164 format.

verifiedboolean

Whether the phone number is verified.

reserved_for_second_factorboolean

Whether the phone number is reserved for multi-factor authentication.

default_second_factorboolean

Whether this is the user's default second factor.

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/phone-numbers"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "phone_number": "+15551234567"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Phone number created for a Clerk user.

phone_number_created.json

{
  "phone_number": {
    "id": "idn_2abc123",
    "phone_number": "+15551234567",
    "verified": true,
    "reserved_for_second_factor": false,
    "default_second_factor": false
  }
}

POST/v1/clerk/redirect-urls

https://api.vee3.io/v1/clerk/redirect-urls

10 tokens

Add an allowed redirect URL to 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.create_redirect_url

Parameters2 fields

clerk_instance_idstringOptional

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

urlstringRequired

Redirect URL to allow for sign-in and sign-up flows.

Response6 fields

redirect_urlobject

5 fields

Created Clerk redirect URL from the Backend API.

objectstring

Clerk object type for the redirect URL.

idstring

Clerk redirect URL id.

urlstring

Allowed redirect URL value.

created_atinteger

Unix timestamp in milliseconds when the redirect URL was created.

updated_atinteger

Unix timestamp in milliseconds when the redirect URL was last updated.

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/redirect-urls"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "url": "https://auth.example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created redirect URL.

created_redirect_url.json

{
  "redirect_url": {
    "object": "redirect_url",
    "id": "reurl_2abc123",
    "url": "https://example.com/dashboard",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/role-sets

https://api.vee3.io/v1/clerk/role-sets

10 tokens

Create a new role set in a connected Clerk application.

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

Parameters8 fields

clerk_instance_idstringOptional

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

namestringRequired

Role set display name.

default_role_keystringRequired

Key of the default role for new members.

creator_role_keystringRequired

Key of the role assigned to organization creators.

rolesarrayRequired

Role keys to include in the role set.

keystringOptional

Unique role set key.

descriptionstringOptional

Role set description.

typestringOptional

Role set type.

Response35 fields

role_setobject

34 fields

Newly created role set summary.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems

8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject

8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject

8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

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/role-sets"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "name": "billing-service",
    "default_role_key": "org:member",
    "creator_role_key": "org:admin",
    "roles": ["org:member"]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A newly created role set.

created_role_set.json

{
  "role_set": {
    "id": "rs_2abc123",
    "name": "Default",
    "key": "default",
    "description": "Default organization roles",
    "roles": [
      {
        "id": "orgrl_2member",
        "name": "Member",
        "key": "org:member",
        "description": "Organization member",
        "created_at": 1710000000000,
        "updated_at": 1710000000000,
        "members_count": 42,
        "has_members": true
      }
    ],
    "default_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "creator_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "type": "default",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/sessions

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

10 tokens

Create a new session for a user in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to create a session for.

Response8 fields

idstring

Clerk session id (sess_...).

user_idstring

Clerk user id (user_...) that owns this session.

statusstring

Current status of the session.

last_active_atinteger

Unix timestamp in milliseconds of the last activity on this session.

expire_atinteger

Unix timestamp in milliseconds when this session expires.

client_idstring

Clerk client id associated with this session.

created_atinteger

Unix timestamp in milliseconds when the session was created.

updated_atinteger

Unix timestamp in milliseconds when the session was last updated.

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/sessions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created session in a connected Clerk application.

created_session.json

{
  "id": "sess_2abc123",
  "user_id": "user_2abc123",
  "status": "active",
  "last_active_at": 1710000000000,
  "expire_at": 1710086400000,
  "client_id": "client_2abc123",
  "created_at": 1710000000000,
  "updated_at": 1710000000000
}

POST/v1/clerk/sessions/{session_id}/tokens

https://api.vee3.io/v1/clerk/sessions/{session_id}/tokens

10 tokens

Create a session token (JWT) for a session in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

session_idstringRequired

Clerk session id (sess_...) to retrieve or modify.

Response1 field

jwtstring

Signed JWT for the session. Treat as a secret — do not log.

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/sessions/{session_id}/tokens"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "session_id": "sess_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created session token JWT.

session_token.json

{
  "jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example.signature"
}

POST/v1/clerk/sessions/{session_id}/tokens/{template_name}

https://api.vee3.io/v1/clerk/sessions/{session_id}/tokens/{template_name}

10 tokens

Create a session token from a JWT template for a session in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

session_idstringRequired

Clerk session id (sess_...) to retrieve or modify.

template_namestringRequired

Name of the JWT template to use when generating the session token.

Response1 field

jwtstring

Signed JWT generated from the template. Treat as a secret — do not log.

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/sessions/{session_id}/tokens/{template_name}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "session_id": "sess_2abc123",
    "template_name": "default"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Session token generated from a named JWT template.

template_session_token.json

{
  "jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.template.signature"
}

POST/v1/clerk/webhooks/svix

https://api.vee3.io/v1/clerk/webhooks/svix

10 tokens

Create a Svix webhook app for a connected Clerk application.

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

Parameters1 field

clerk_instance_idstringOptional

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

Response2 fields

svixobject

1 field

Svix app response from the Clerk Backend API.

svix_urlstring

Temporary Svix URL. Treat as sensitive — do not log.

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/webhooks/svix"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {

}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Svix app created for the connected Clerk instance.

created_svix_app.json

{
  "svix": {
    "svix_url": "https://app.svix.com/login?token=example"
  }
}

POST/v1/clerk/waitlist-entries

https://api.vee3.io/v1/clerk/waitlist-entries

10 tokens

Add an email address to the waitlist in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

email_addressstringRequired

Email address to add to the waitlist.

notifybooleanOptional

Whether to notify the user their email was added. Defaults to true.

Response7 fields

waitlist_entryobject

6 fields

Created or existing Clerk waitlist entry from the Backend API.

idstring

Waitlist entry id (wle_...).

email_addressstring

Email address on the waitlist.

statusstring

Waitlist status: "pending", "invited", "rejected", or "completed".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

is_lockedboolean

Whether the entry is locked during batch processing.

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/waitlist-entries"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "email_address": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created waitlist entry.

created_waitlist_entry.json

{
  "waitlist_entry": {
    "id": "wle_2abc123",
    "email_address": "ada@example.com",
    "status": "pending",
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "is_locked": false
  }
}

DELETE/v1/clerk/api-keys/{api_key_id}

https://api.vee3.io/v1/clerk/api-keys/{api_key_id}

10 tokens

Permanently delete an API key from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

api_key_idstringRequired

Clerk API key id (ak_...) to retrieve, update, delete, or revoke.

Response3 fields

api_keyobject

2 fields

Deletion confirmation with API key id and deleted flag.

idstring

Deleted API key id.

deletedboolean

Always true when deletion succeeded.

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/api-keys/{api_key_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "api_key_id": "ak_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Confirmation that the Clerk API key was deleted.

deleted_api_key.json

{
  "api_key": {
    "id": "ak_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/domains/{domain_id}

https://api.vee3.io/v1/clerk/domains/{domain_id}

10 tokens

Remove a custom domain from 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.delete_domain

Parameters2 fields

clerk_instance_idstringOptional

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

domain_idstringRequired

Clerk organization domain id (dmn_...) to update, delete, or verify.

Response4 fields

domainobject

3 fields

Clerk deleted-object payload confirming domain removal.

objectstring

Clerk object type for the deleted resource.

idstring

Deleted resource id.

deletedboolean

Whether the resource was deleted.

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/domains/{domain_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "domain_id": "dmn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted custom domain confirmation.

deleted_domain.json

{
  "domain": {
    "object": "domain",
    "id": "dmn_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/email-addresses/{email_address_id}

https://api.vee3.io/v1/clerk/email-addresses/{email_address_id}

10 tokens

Delete a Clerk email address by id.

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

Parameters2 fields

clerk_instance_idstringOptional

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

email_address_idstringRequired

Clerk email address id (idn_...) to retrieve or modify.

Response9 fields

email_addressobject

8 fields

Deleted Clerk email address summary, when returned by Clerk.

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

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/email-addresses/{email_address_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "email_address_id": "idn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk email address after deletion.

deleted_email_address.json

{
  "email_address": {
    "id": "idn_2abc123",
    "user_id": "user_2abc123",
    "email_address": "ada@example.com",
    "verification_status": "verified",
    "verified": true,
    "primary": false,
    "created_at": 1710000000000,
    "updated_at": 1710086400000
  }
}

DELETE/v1/clerk/enterprise-connections/{connection_id}

https://api.vee3.io/v1/clerk/enterprise-connections/{connection_id}

10 tokens

Delete an enterprise SSO connection from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

connection_idstringRequired

Clerk enterprise connection id (entc_...) to retrieve, update, delete, or test.

Response37 fields

enterprise_connectionobject

36 fields

Deleted enterprise connection object returned by Clerk.

idstring

Enterprise connection id.

namestring

Display name for the connection.

providerstring

Identity provider key (for example saml_custom or oidc_custom).

activeboolean

Whether the connection is active.

domainsstring[]

Email domains that may use this connection.

created_atinteger

Unix timestamp in milliseconds when the connection was created.

updated_atinteger

Unix timestamp in milliseconds when the connection was last updated.

logo_public_urlstring

Public logo URL for the connection when available.

organization_idstring

Linked Clerk organization id (org_...) when the connection is org-scoped.

sync_user_attributesboolean

Whether user attributes sync on each sign-in.

disable_additional_identificationsboolean

Whether users may add additional identifications with this connection.

allow_organization_account_linkingboolean

Whether account linking via organization membership is supported.

custom_attributesarrayitems

5 fields

Custom attribute mappings from the IdP to user metadata.

namestring

Display name for the custom attribute.

keystring

Metadata key used to store the attribute on the user.

sso_pathstring

Path to extract the value from SSO claims.

scim_pathstring

GJSON path to extract the value from SCIM resources.

multi_valuedboolean

Whether the attribute supports multiple values.

saml_connectionobject

9 fields

SAML configuration when the connection uses SAML.

idstring

SAML connection id when the connection uses SAML.

namestring

SAML connection display name.

idp_entity_idstring

Identity Provider entity id.

idp_sso_urlstring

Identity Provider Single Sign-On URL.

acs_urlstring

Assertion Consumer Service URL.

sp_entity_idstring

Service Provider entity id (Clerk).

activeboolean

Whether the SAML connection is active.

allow_idp_initiatedboolean

Whether IdP-initiated SSO is allowed.

allow_subdomainsboolean

Whether email subdomains may use this connection.

oauth_configobject

6 fields

OIDC configuration when the connection uses OAuth.

idstring

OAuth config id when the connection uses OIDC.

namestring

Custom OIDC provider display name.

provider_keystring

OAuth provider key (for example oidc_custom).

client_idstring

OAuth client id.

discovery_urlstring

OIDC discovery URL.

requires_pkceboolean

Whether PKCE is required for this OAuth client.

deletedboolean

Whether the connection was deleted.

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/enterprise-connections/{connection_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "connection_id": "conn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted enterprise connection object.

deleted_enterprise_connection.json

{
  "enterprise_connection": {
    "object": "enterprise_connection",
    "id": "entc_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/jwt-templates/{template_id}

https://api.vee3.io/v1/clerk/jwt-templates/{template_id}

10 tokens

Permanently delete a JWT template from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

template_idstringRequired

Clerk JWT template id (jtmp_...) to retrieve, update, or delete.

Response3 fields

jwt_templateobject

2 fields

Deletion confirmation with template id and deleted flag.

idstring

Deleted JWT template id.

deletedboolean

Always true when deletion succeeded.

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/jwt-templates/{template_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "template_id": "jtmp_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Confirmation that the Clerk JWT template was deleted.

deleted_jwt_template.json

{
  "jwt_template": {
    "id": "jtmp_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/machines/{machine_id}

https://api.vee3.io/v1/clerk/machines/{machine_id}

10 tokens

Permanently delete a machine from 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.delete_machine

Parameters2 fields

clerk_instance_idstringOptional

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

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

Response4 fields

deleted_machineobject

3 fields

Deleted machine confirmation from the Backend API.

objectstring

Object type.

idstring

Deleted machine id.

deletedboolean

Whether the machine was deleted.

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/machines/{machine_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "machine_id": "mch_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Confirmation that the Clerk machine was deleted.

deleted_machine.json

{
  "deleted_machine": {
    "object": "deleted",
    "id": "mch_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/oauth-applications/{oauth_application_id}

https://api.vee3.io/v1/clerk/oauth-applications/{oauth_application_id}

10 tokens

Delete an OAuth application from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

oauth_application_idstringRequired

Clerk OAuth application id (oa_...) to retrieve, update, or delete.

Response19 fields

oauth_applicationobject

18 fields

Deleted Clerk OAuth application object from the Backend API.

idstring

OAuth application id (oa_...).

namestring

OAuth application display name.

client_idstring

OAuth client id issued to authorized clients.

client_secretstring

OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.

client_image_urlstring

URL of the OAuth application logo when set.

client_uristring

Homepage URI for the OAuth client.

redirect_urisstring[]

Allowed redirect URIs for the OAuth authorization flow.

scopesstring

Space-delimited scopes granted by this OAuth application.

consent_screen_enabledboolean

Whether the consent screen is shown during authorization.

publicboolean

Whether this is a public OAuth client (PKCE-capable, no client secret).

pkce_requiredboolean

Whether PKCE is required for the authorization flow.

dynamically_registeredboolean

Whether the OAuth application was registered dynamically.

instance_idstring

Clerk instance id (ins_...) that owns this OAuth application.

authorize_urlstring

Authorization endpoint URL for this OAuth application.

token_fetch_urlstring

Token endpoint URL for exchanging authorization codes.

discovery_urlstring

OpenID Connect discovery document URL.

created_atinteger

Unix timestamp in milliseconds when the OAuth application was created.

updated_atinteger

Unix timestamp in milliseconds when the OAuth application was last updated.

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/oauth-applications/{oauth_application_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "oauth_application_id": "oa_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200A deleted Clerk OAuth application.

deleted_oauth_application.json

{
  "oauth_application": {
    "id": "oa_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/organizations/{organization_id}

https://api.vee3.io/v1/clerk/organizations/{organization_id}

10 tokens

Permanently delete an organization from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

organization_idstringRequired

Clerk organization id (org_...) to operate on.

Response3 fields

organizationobject

2 fields

Deletion confirmation with organization id and deleted flag.

idstring

Deleted organization id.

deletedboolean

Always true when deletion succeeded.

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/organizations/{organization_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Confirmation that the Clerk organization was deleted.

deleted_organization.json

{
  "organization": {
    "id": "org_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/organization-domains/{domain_id}

https://api.vee3.io/v1/clerk/organization-domains/{domain_id}

10 tokens

Remove an organization domain from a Clerk organization.

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

Parameters2 fields

clerk_instance_idstringOptional

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

domain_idstringRequired

Clerk organization domain id (dmn_...) to update, delete, or verify.

Response4 fields

deleted_domainobject

3 fields

Deletion confirmation with domain id and deleted flag.

objectstring

Deleted object type (deleted).

idstring

Deleted organization domain id.

deletedboolean

Always true when deletion succeeded.

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/organization-domains/{domain_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "domain_id": "dmn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Confirmation that the organization domain was deleted.

deleted_domain.json

{
  "deleted_domain": {
    "object": "deleted",
    "id": "dmn_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/organization-permissions/{permission_id}

https://api.vee3.io/v1/clerk/organization-permissions/{permission_id}

10 tokens

Delete an organization permission from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

permission_idstringRequired

Clerk organization permission id to retrieve, update, delete, or assign to a role.

Response3 fields

organization_permissionobject

2 fields

Clerk deletion payload for the organization permission.

idstring

Deleted permission id.

deletedboolean

Whether the permission was deleted.

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/organization-permissions/{permission_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "permission_id": "orgperm_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted organization permission.

deleted_organization_permission.json

{
  "organization_permission": {
    "id": "orgperm_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/organization-roles/{role_id}

https://api.vee3.io/v1/clerk/organization-roles/{role_id}

10 tokens

Delete an organization role from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

role_idstringRequired

Clerk organization role id to retrieve, update, delete, or assign permissions to.

Response3 fields

organization_roleobject

2 fields

Clerk deletion payload for the organization role.

idstring

Deleted role id.

deletedboolean

Whether the role was deleted.

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/organization-roles/{role_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "role_id": "orgrole_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted organization role.

deleted_organization_role.json

{
  "organization_role": {
    "id": "orgrl_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/phone-numbers/{phone_number_id}

https://api.vee3.io/v1/clerk/phone-numbers/{phone_number_id}

10 tokens

Delete a Clerk phone number.

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

Parameters2 fields

clerk_instance_idstringOptional

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

phone_number_idstringRequired

Clerk phone number id (idn_... or phn_...) to retrieve or modify.

Response4 fields

deletedobject

3 fields

Deleted object confirmation from the Clerk Backend API.

idstring

Deleted phone number id.

objectstring

Object type that was deleted.

deletedboolean

Whether the object was deleted.

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/phone-numbers/{phone_number_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "phone_number_id": "phn_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted Clerk phone number.

phone_number_deleted.json

{
  "deleted": {
    "id": "idn_2abc123",
    "object": "phone_number",
    "deleted": true
  }
}

DELETE/v1/clerk/redirect-urls/{redirect_url_id}

https://api.vee3.io/v1/clerk/redirect-urls/{redirect_url_id}

10 tokens

Remove an allowed redirect URL from 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.delete_redirect_url

Parameters2 fields

clerk_instance_idstringOptional

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

redirect_url_idstringRequired

Clerk redirect URL id to retrieve or delete.

Response4 fields

redirect_urlobject

3 fields

Clerk deleted-object payload confirming redirect URL removal.

objectstring

Clerk object type for the deleted resource.

idstring

Deleted resource id.

deletedboolean

Whether the resource was deleted.

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/redirect-urls/{redirect_url_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "redirect_url_id": "ru_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted redirect URL confirmation.

deleted_redirect_url.json

{
  "redirect_url": {
    "object": "redirect_url",
    "id": "reurl_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/webhooks/svix

https://api.vee3.io/v1/clerk/webhooks/svix

10 tokens

Delete the Svix webhook app from a connected Clerk application.

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

Parameters1 field

clerk_instance_idstringOptional

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

Response2 fields

svixobject

1 field

Deletion confirmation for the Svix app.

deletedboolean

True when the Svix app was deleted.

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/webhooks/svix"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {

}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Confirmation that the Svix app was deleted.

deleted_svix_app.json

{
  "svix": {
    "deleted": true
  }
}

DELETE/v1/clerk/users/{user_id}

https://api.vee3.io/v1/clerk/users/{user_id}

10 tokens

Permanently delete a user from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to delete.

Response6 fields

userobject

5 fields

Deleted Clerk user object from the Backend API, when returned.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

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/users/{user_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted Clerk user.

deleted_user.json

{
  "user": {
    "id": "user_2abc123",
    "deleted": true
  }
}

DELETE/v1/clerk/waitlist-entries/{waitlist_entry_id}

https://api.vee3.io/v1/clerk/waitlist-entries/{waitlist_entry_id}

10 tokens

Delete a pending waitlist entry from a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

waitlist_entry_idstringRequired

Clerk waitlist entry id (wle_...) to operate on.

Response4 fields

deletedobject

3 fields

Clerk deleted-object payload.

objectstring

Clerk object type for the deleted resource.

idstring

Deleted identifier id.

deletedboolean

Whether the identifier was deleted.

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/waitlist-entries/{waitlist_entry_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "waitlist_entry_id": "waitlist_entry_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Deleted waitlist entry confirmation.

deleted_waitlist_entry.json

{
  "deleted": {
    "object": "waitlist_entry",
    "id": "wle_2abc123",
    "deleted": true
  }
}

GET/v1/clerk/users/{user_id}/oauth-access-tokens/{provider}

https://api.vee3.io/v1/clerk/users/{user_id}/oauth-access-tokens/{provider}

10 tokens

Retrieve stored OAuth access tokens for a user and provider.

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_user_oauth_access_token

Parameters6 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to operate on.

providerstringRequired

OAuth provider id (for example oauth_google).

paginatedbooleanOptional

Whether to paginate results.

limitintegerOptional

Maximum tokens to return when paginated.

offsetintegerOptional

Number of tokens to skip when paginated.

Response4 fields

oauth_access_tokensarrayitems

3 fields

OAuth access token objects for the user and provider. Treat token values as secrets.

objectstring

Object type (oauth_access_token).

providerstring

OAuth provider id (for example oauth_google).

tokenstring

OAuth access token secret. Treat as high-privilege — do not log.

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/users/{user_id}/oauth-access-tokens/{provider}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
params = {
    "user_id": "user_2abc123",
    "provider": "oauth_google"
}

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

Example responses1 example

200Successful response.

success.json

{
  "oauth_access_tokens": [
    {
      "object": "oauth_access_token",
      "provider": "oauth_google",
      "token": "ya29.example"
    }
  ]
}

POST/v1/clerk/waitlist-entries/{waitlist_entry_id}/invite

https://api.vee3.io/v1/clerk/waitlist-entries/{waitlist_entry_id}/invite

10 tokens

Send an invite to a waitlist entry email address.

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

Parameters3 fields

clerk_instance_idstringOptional

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

waitlist_entry_idstringRequired

Clerk waitlist entry id (wle_...) to operate on.

ignore_existingbooleanOptional

When true, create an invitation even if one already exists for this email.

Response7 fields

waitlist_entryobject

6 fields

Updated Clerk waitlist entry after inviting.

idstring

Waitlist entry id (wle_...).

email_addressstring

Email address on the waitlist.

statusstring

Waitlist status: "pending", "invited", "rejected", or "completed".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

is_lockedboolean

Whether the entry is locked during batch processing.

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/waitlist-entries/{waitlist_entry_id}/invite"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "waitlist_entry_id": "waitlist_entry_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Waitlist entry after sending an invite.

invited_waitlist_entry.json

{
  "waitlist_entry": {
    "id": "wle_2abc123",
    "email_address": "ada@example.com",
    "status": "invited",
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "is_locked": false
  }
}

POST/v1/clerk/waitlist-entries/{waitlist_entry_id}/reject

https://api.vee3.io/v1/clerk/waitlist-entries/{waitlist_entry_id}/reject

10 tokens

Reject a waitlist entry in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

waitlist_entry_idstringRequired

Clerk waitlist entry id (wle_...) to operate on.

Response7 fields

waitlist_entryobject

6 fields

Updated Clerk waitlist entry after rejection.

idstring

Waitlist entry id (wle_...).

email_addressstring

Email address on the waitlist.

statusstring

Waitlist status: "pending", "invited", "rejected", or "completed".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

is_lockedboolean

Whether the entry is locked during batch processing.

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/waitlist-entries/{waitlist_entry_id}/reject"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "waitlist_entry_id": "waitlist_entry_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Waitlist entry after rejection.

rejected_waitlist_entry.json

{
  "waitlist_entry": {
    "id": "wle_2abc123",
    "email_address": "ada@example.com",
    "status": "rejected",
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "is_locked": false
  }
}

POST/v1/clerk/role-sets/{role_set_id}/replace

https://api.vee3.io/v1/clerk/role-sets/{role_set_id}/replace

10 tokens

Replace a role set with another role set in a connected Clerk application.

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

Parameters4 fields

clerk_instance_idstringOptional

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

role_set_idstringRequired

Clerk role set id or key to retrieve, update, or modify.

dest_role_set_keystringRequired

Key of the destination role set to migrate members to.

reassignment_mappingsobjectOptional

Optional map of source role keys to destination role keys.

Response3 fields

role_set_migrationobject

2 fields

Clerk role set migration payload.

idstring

Role set migration id.

statusstring

Migration status (for example pending or completed).

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/role-sets/{role_set_id}/replace"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "role_set_id": "orgroleset_2abc123",
    "dest_role_set_key": "default"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Role set migration started.

role_set_migration.json

{
  "role_set_migration": {
    "id": "rsm_2abc123",
    "status": "pending"
  }
}

POST/v1/clerk/role-sets/{role_set_id}/roles/replace

https://api.vee3.io/v1/clerk/role-sets/{role_set_id}/roles/replace

10 tokens

Replace one role with another in a role set.

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

Parameters4 fields

clerk_instance_idstringOptional

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

role_set_idstringRequired

Clerk role set id or key to retrieve, update, or modify.

role_keystringRequired

Key of the role to replace in the role set.

to_role_keystringRequired

Key of the replacement role.

Response35 fields

role_setobject

34 fields

Updated role set summary.

idstring

Clerk role set id.

namestring

Role set display name.

keystring

Role set key.

descriptionstring

Role set description.

rolesarrayitems

8 fields

Roles included in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

default_roleobject

8 fields

Default role for new members in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

creator_roleobject

8 fields

Role assigned to organization creators in this role set.

idstring

Role id within the role set.

namestring

Role display name.

keystring

Role key.

descriptionstring

Role description.

created_atinteger

Unix timestamp in milliseconds when the role was created.

updated_atinteger

Unix timestamp in milliseconds when the role was last updated.

members_countinteger

Number of members assigned this role in the role set.

has_membersboolean

Whether any members are assigned this role.

typestring

Role set type.

created_atinteger

Unix timestamp in milliseconds when the role set was created.

updated_atinteger

Unix timestamp in milliseconds when the role set was last updated.

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/role-sets/{role_set_id}/roles/replace"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "role_set_id": "orgroleset_2abc123",
    "role_key": "org:member",
    "to_role_key": "org:admin"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Role set after replacing a role.

role_set_replaced_role.json

{
  "role_set": {
    "id": "rs_2abc123",
    "name": "Default",
    "key": "default",
    "description": "Default organization roles",
    "roles": [
      {
        "id": "orgrl_2member",
        "name": "Member",
        "key": "org:member",
        "description": "Organization member",
        "created_at": 1710000000000,
        "updated_at": 1710000000000,
        "members_count": 42,
        "has_members": true
      }
    ],
    "default_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "creator_role": {
      "id": "orgrl_2member",
      "name": "Member",
      "key": "org:member",
      "description": "Organization member",
      "created_at": 1710000000000,
      "updated_at": 1710000000000,
      "members_count": 42,
      "has_members": true
    },
    "type": "default",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/machines/{machine_id}/rotate-secret-key

https://api.vee3.io/v1/clerk/machines/{machine_id}/rotate-secret-key

10 tokens

Rotate a machine's secret key in 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.rotate_machine_secret_key

Parameters3 fields

clerk_instance_idstringOptional

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

machine_idstringRequired

Clerk machine id (mch_...) to retrieve or modify.

previous_token_ttlintegerRequired

Seconds the previous secret key remains valid after rotation (0–28800).

min 0, max 28800

Response3 fields

machine_secret_keyobject

2 fields

Rotated machine secret key payload from the Backend API.

objectstring

Object type (machine_secret_key).

secretstring

Machine secret key. Treat as high-privilege — do not log.

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/machines/{machine_id}/rotate-secret-key"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "machine_id": "mch_2abc123",
    "previous_token_ttl": 3600
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200New secret key after rotation.

rotated_machine_secret_key.json

{
  "machine_secret_key": {
    "object": "machine_secret_key",
    "secret": "msk_test_secret_value"
  }
}

POST/v1/clerk/oauth-applications/{oauth_application_id}/rotate-secret

https://api.vee3.io/v1/clerk/oauth-applications/{oauth_application_id}/rotate-secret

10 tokens

Rotate the client secret for an OAuth application in a connected Clerk application.

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

Parameters2 fields

clerk_instance_idstringOptional

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

oauth_application_idstringRequired

Clerk OAuth application id (oa_...) to retrieve, update, or delete.

Response19 fields

oauth_applicationobject

18 fields

OAuth application summary with the new client_secret.

idstring

OAuth application id (oa_...).

namestring

OAuth application display name.

client_idstring

OAuth client id issued to authorized clients.

client_secretstring

OAuth client secret. Empty for public clients. Treat as high-privilege — do not log.

client_image_urlstring

URL of the OAuth application logo when set.

client_uristring

Homepage URI for the OAuth client.

redirect_urisstring[]

Allowed redirect URIs for the OAuth authorization flow.

scopesstring

Space-delimited scopes granted by this OAuth application.

consent_screen_enabledboolean

Whether the consent screen is shown during authorization.

publicboolean

Whether this is a public OAuth client (PKCE-capable, no client secret).

pkce_requiredboolean

Whether PKCE is required for the authorization flow.

dynamically_registeredboolean

Whether the OAuth application was registered dynamically.

instance_idstring

Clerk instance id (ins_...) that owns this OAuth application.

authorize_urlstring

Authorization endpoint URL for this OAuth application.

token_fetch_urlstring

Token endpoint URL for exchanging authorization codes.

discovery_urlstring

OpenID Connect discovery document URL.

created_atinteger

Unix timestamp in milliseconds when the OAuth application was created.

updated_atinteger

Unix timestamp in milliseconds when the OAuth application was last updated.

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/oauth-applications/{oauth_application_id}/rotate-secret"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "oauth_application_id": "oa_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200OAuth application after secret rotation.

rotated_oauth_application_secret.json

{
  "oauth_application": {
    "id": "oa_2abc123",
    "name": "My OAuth App",
    "client_id": "client_2abc123",
    "client_secret": "new_secret_value",
    "updated_at": 1710100000000
  }
}

POST/v1/clerk/actor-tokens

https://api.vee3.io/v1/clerk/actor-tokens

15 tokens

Create an impersonation actor token for a user in a connected Clerk application.

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

Parameters5 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) of the user being impersonated.

actor_substringRequired

Clerk user id (user_...) of the impersonating actor (maps to actor.sub).

expires_in_secondsintegerOptional

Actor token lifetime in seconds (minimum 1). Defaults to 3600 (1 hour).

min 1

session_max_duration_in_secondsintegerOptional

Maximum duration in seconds for the session created from this token (minimum 1). Defaults to 1800 (30 minutes).

min 1

Response10 fields

actor_tokenobject

9 fields

Created Clerk actor token object from the Backend API.

idstring

Actor token id.

user_idstring

Clerk user id (user_...) being impersonated.

statusstring

Token status (pending, accepted, or revoked).

actorobject

1 field

Actor payload; includes sub with the impersonating user id.

substring

Clerk user id (user_...) of the impersonating actor.

tokenstring

Actor token secret. Treat as high-privilege — do not log.

urlstring

Optional sign-in URL that includes the actor token.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

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/actor-tokens"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123",
    "actor_sub": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk actor token.

created_actor_token.json

{
  "actor_token": {
    "id": "act_2abc123",
    "user_id": "user_impersonated",
    "status": "pending",
    "actor": {
      "sub": "user_actor"
    },
    "token": "secret_actor_token_value",
    "url": "https://example.com/sign-in?token=secret_actor_token_value",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/admin-portal-link-tokens

https://api.vee3.io/v1/clerk/admin-portal-link-tokens

15 tokens

Create a single-use admin portal deep link token in 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.create_admin_portal_link_token

Parameters5 fields

clerk_instance_idstringOptional

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

organization_idstringOptional

Optional organization id (org_...) to scope the admin portal link.

it_contact_idstringOptional

Optional opaque IT contact reference for the link.

scopesarrayOptional

Optional scopes for the link (for example "admin_portal:read").

seconds_until_expirationintegerOptional

Link token lifetime in seconds (default 3600, max 86400).

min 1, max 86400

Response9 fields

admin_portal_link_tokenobject

8 fields

Created admin portal link token from the Backend API.

idstring

Admin portal link token id (aplt_...).

admin_portal_link_idstring

Origin admin portal link id (apl_...).

instance_idstring

Clerk instance id (ins_...).

tokenstring

Single-use admin portal link token when returned on creation. Treat as high-privilege — do not log.

revokedboolean

Whether the link token has been revoked.

expiredboolean

Whether the link token has expired.

expirationinteger

Unix timestamp in milliseconds when the link token expires.

created_atinteger

Unix timestamp in milliseconds when the link token was created.

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/admin-portal-link-tokens"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "organization_id": "org_2xyz789",
    "it_contact_id": "it_contact_2abc123",
    "scopes": ["read","write"]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Single-use admin portal deep link token.

created_admin_portal_link_token.json

{
  "admin_portal_link_token": {
    "id": "aplt_3beecc9c60adb5f9b850e91a83beecc9",
    "admin_portal_link_id": "apl_3beecc9c60adb5f9b850e91a8d2",
    "instance_id": "ins_2abc123",
    "token": "aplt_secret_token_value",
    "revoked": false,
    "expired": false,
    "expiration": 1710003600000,
    "created_at": 1710000000000
  }
}

POST/v1/clerk/m2m-tokens

https://api.vee3.io/v1/clerk/m2m-tokens

15 tokens

Create a machine-to-machine token in 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.create_m2m_token

Parameters6 fields

clerk_instance_idstringOptional

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

machine_secret_keystringRequired

Machine secret key (msk_...) used to authenticate the create request.

token_formatstringOptional

Token format: "opaque" (default) or "jwt".

seconds_until_expirationnumberOptional

Token lifetime in seconds.

min 0

claimsobjectOptional

Optional custom claims embedded in the token.

min_remaining_ttl_secondsintegerOptional

For opaque tokens, reuse an existing token with at least this TTL remaining.

min 0

Response9 fields

m2m_tokenobject

8 fields

Created M2M token from the Backend API.

idstring

M2M token id (mt_...).

subjectstring

Machine id (mch_...) that created or owns the token.

tokenstring

M2M token secret when returned on creation. Treat as high-privilege — do not log.

revokedboolean

Whether the token has been revoked.

expiredboolean

Whether the token has expired.

expirationinteger

Unix timestamp in milliseconds when the token expires.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

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/m2m-tokens"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "machine_secret_key": "msk_test_secret_value"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created opaque M2M token.

created_m2m_token.json

{
  "m2m_token": {
    "id": "mt_f7f0ba8c3b4843ce7d85fcdd5e71853e",
    "subject": "mch_2abc123",
    "token": "mt_secret_token_value",
    "revoked": false,
    "expired": false,
    "expiration": 1710003600000,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}

POST/v1/clerk/sign-in-tokens

https://api.vee3.io/v1/clerk/sign-in-tokens

15 tokens

Create a magic-link style sign-in token for a user in a connected Clerk application.

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

Parameters3 fields

clerk_instance_idstringOptional

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

user_idstringRequired

Clerk user id (user_...) to retrieve or modify.

expires_in_secondsintegerOptional

Token lifetime in seconds (minimum 1). Defaults to 2592000 (30 days).

min 1

Response8 fields

sign_in_tokenobject

7 fields

Created Clerk sign-in token object from the Backend API.

idstring

Sign-in token id.

user_idstring

Clerk user id (user_...) the token is for.

statusstring

Token status (pending, accepted, or revoked).

tokenstring

Sign-in token secret. Treat as high-privilege — do not log.

urlstring

Optional sign-in URL that includes the token.

created_atinteger

Unix timestamp in milliseconds when the token was created.

updated_atinteger

Unix timestamp in milliseconds when the token was last updated.

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/sign-in-tokens"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "user_id": "user_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created Clerk sign-in token.

created_sign_in_token.json

{
  "sign_in_token": {
    "id": "sit_2abc123",
    "user_id": "user_2abc123",
    "status": "pending",
    "token": "secret_sign_in_token_value",
    "url": "https://example.com/sign-in?token=secret_sign_in_token_value",
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}