List Clerk machines

List machine-to-machine identities in a connected Clerk instance.

← All Clerk endpoints · Capability overview

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
}