Create Clerk admin portal link token

Create a single-use admin portal deep link token in a connected Clerk instance.

← All Clerk endpoints · Capability overview

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