Reads one linked account.

Reads one linked account. It answers a single link — its device, provider, account, plan, how it bills, its status and its latest usage snapshot.

GET /v1/link/{id}

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


Address	`https://api.hanzo.ai/v1/link/{id}`
Method	`GET`
Operation	`get_link_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads one linked account.

It answers a single link — its device, provider, account, plan, how it bills, its status and its latest usage snapshot. An id that does not exist, or belongs to another user or org, is the same 404: the scope is a bound predicate on the read, so a wrong id and a foreign id are indistinguishable and neither confirms the other's existence. The static paths on this collection — route, usage, devices — register before this one and win first-match, so a link whose id collided with one of those words could not be addressed here.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the link to act on, from the path.

Response

Status	Body	Meaning
`200`	linkView	ok

200 body — 15 fields.

Field	In	Type	Always	Description
`account`	body	string	—	Account is the provider-side account identifier, when the collector knows it.
`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).
`createdAt`	body	string	—	CreatedAt is when the link was first registered, RFC 3339 UTC.
`host`	body	string	—	Host is the machine's human hostname label, from its most recent report.
`id`	body	string	—	ID is the link's opaque handle ("link_" + 32 hex chars).
`kind`	body	string	—	Kind is how the account authenticates: subscription or apikey.
`lastSeen`	body	string	—	LastSeen is when the account last reported, RFC 3339 UTC.
`machine`	body	string	—	Machine is the stable machine identifier the collector reports.
`os`	body	string	—	OS is the machine's operating system label.
`plan`	body	string	—	Plan is the provider plan label (e.g.
`provider`	body	string	—	Provider is the AI provider this account belongs to (claude, openai, hanzo…).
`status`	body	string	—	Status is linked or revoked.
`updatedAt`	body	string	—	UpdatedAt is when the link was last refreshed, RFC 3339 UTC.
`usage`	body	any	—	Usage is the last good usage snapshot, clamped and re-serialized to known fields at ingest.
`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 get <id>

import { Configuration, LinkApi } from 'hanzoai';

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

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_by_id(id='id')

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

resp, _, err := client.LinkAPI.GetLinkById(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_by_id(&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).getLinkById();

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/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches link through the link tool, which names its 11 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

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

Link API · All Hanzo APIs · Interactive reference

Reads one linked account.

Request

Response

Examples

On this page