Lists your linked accounts and the devices they sit on.

GET /v1/link

Link → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/link`
Method	`GET`
Operation	`get_link`
Auth	`Authorization: Bearer $HANZO_API_KEY`

It answers the caller's own links plus a devices projection of the same rows folded per machine — the cross-machine "AI Providers / Accounts" view. A device is a projection, not a stored entity: its labels come from its most-recently-seen account, so there is no device to create and none to garbage-collect. Revoked links are INCLUDED rather than dropped, because a logged-out account keeps its usage history and audit trail. Scoped to the caller: a validated principal and a non-empty org, else 403.

Request

GET /v1/link takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	linkList	ok

200 body — 38 fields.

Field	In	Type	Always	Description
`devices`	body	deviceView[]	—	Devices is the same rows folded per machine — the cross-machine "AI Providers / Accounts" view.
`devices[].accounts`	body	linkView[]	—	Accounts is every account the caller has signed in on this machine.
`devices[].accounts[].account`	body	string	—	Account is the provider-side account identifier, when the collector knows it.
`devices[].accounts[].billing`	body	string	—	Billing is how this account's inference bills — plan (the user's own subscription, metered here for visibility only) or commerce (the gateway path).
`devices[].accounts[].createdAt`	body	string	—	CreatedAt is when the link was first registered, RFC 3339 UTC.
`devices[].accounts[].host`	body	string	—	Host is the machine's human hostname label, from its most recent report.
`devices[].accounts[].id`	body	string	—	ID is the link's opaque handle ("link_" + 32 hex chars).
`devices[].accounts[].kind`	body	string	—	Kind is how the account authenticates: subscription or apikey.
`devices[].accounts[].lastSeen`	body	string	—	LastSeen is when the account last reported, RFC 3339 UTC.
`devices[].accounts[].machine`	body	string	—	Machine is the stable machine identifier the collector reports.
`devices[].accounts[].os`	body	string	—	OS is the machine's operating system label.
`devices[].accounts[].plan`	body	string	—	Plan is the provider plan label (e.g.
`devices[].accounts[].provider`	body	string	—	Provider is the AI provider this account belongs to (claude, openai, hanzo…).
`devices[].accounts[].status`	body	string	—	Status is linked or revoked.
`devices[].accounts[].updatedAt`	body	string	—	UpdatedAt is when the link was last refreshed, RFC 3339 UTC.
`devices[].accounts[].usage`	body	any	—	Usage is the last good usage snapshot, clamped and re-serialized to known fields at ingest.
`devices[].accounts[].user`	body	string	—	User is the owning subject — the validated caller who registered the link.
`devices[].activeSessions`	body	integer	—	ActiveSessions is how many agent sessions the caller currently has running on this machine; 0 where the agent plane is not mounted.
`devices[].host`	body	string	—	Host is the machine's hostname label, from its most-recently-seen account.
`devices[].lastSeen`	body	string	—	LastSeen is when any account on this machine last reported, RFC 3339 UTC.
`devices[].machine`	body	string	—	Machine is the stable machine identifier.
`devices[].os`	body	string	—	OS is the machine's operating system label.
`links`	body	linkView[]	—	Links is every link the caller registered, newest first.
`links[].account`	body	string	—	Account is the provider-side account identifier, when the collector knows it.
`links[].billing`	body	string	—	Billing is how this account's inference bills — plan (the user's own subscription, metered here for visibility only) or commerce (the gateway path).
`links[].createdAt`	body	string	—	CreatedAt is when the link was first registered, RFC 3339 UTC.
`links[].host`	body	string	—	Host is the machine's human hostname label, from its most recent report.
`links[].id`	body	string	—	ID is the link's opaque handle ("link_" + 32 hex chars).
`links[].kind`	body	string	—	Kind is how the account authenticates: subscription or apikey.
`links[].lastSeen`	body	string	—	LastSeen is when the account last reported, RFC 3339 UTC.
`links[].machine`	body	string	—	Machine is the stable machine identifier the collector reports.
`links[].os`	body	string	—	OS is the machine's operating system label.
`links[].plan`	body	string	—	Plan is the provider plan label (e.g.
`links[].provider`	body	string	—	Provider is the AI provider this account belongs to (claude, openai, hanzo…).
`links[].status`	body	string	—	Status is linked or revoked.
`links[].updatedAt`	body	string	—	UpdatedAt is when the link was last refreshed, RFC 3339 UTC.
`links[].usage`	body	any	—	Usage is the last good usage snapshot, clamped and re-serialized to known fields at ingest.
`links[].user`	body	string	—	User is the owning subject — the validated caller who registered the link.

Failure carries the platform error shape — see Errors.

Examples

hanzo links list

import { Configuration, LinkApi } from 'hanzoai';

const api = new LinkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getLink();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LinkApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LinkApi(client).get_link()

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.LinkAPI.GetLink(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, link_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = link_api::get_link(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LinkApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new LinkApi(client).getLink();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/link \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool link, op get_link — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "link",
         "arguments": {
           "op": "get_link",
           "input": {}
         }
       }
     }'

Link API · All Hanzo APIs · Interactive reference

Lists your linked accounts and the devices they sit on.

Request

Response

Examples

On this page