Reports one destination's card for the caller's org — its config fields, its…
Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now.
GET /v1/destination/{platform}
| Address | https://api.hanzo.ai/v1/destination/{platform} |
| Method | GET |
| Operation | get_destination_by_platform |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now. A platform this deployment does not carry is not found.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
platform | path | string | yes | Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights | analytics. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | DestinationStatus | ok |
200 body — 16 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
account | body | string | — | Account is the operator's own label for the connected account, as supplied on connect. |
category | body | string | — | groups the card: Analytics | Advertising |
config | body | object | — | Config is the org's stored NON-SECRET configuration — the measurement/pixel ids keyed by DestinationField.Key. |
config.* | body | string | — | |
connected | body | boolean | — | Connected is true when this org has a stored row for the platform — it has been configured here at least once. |
enabled | body | boolean | — | Enabled is whether the fan-out forwards to this destination. |
fields | body | DestinationField[] | — | Fields are the non-secret inputs this platform needs, which the console card renders and the connect body fills. |
fields[].example | body | string | — | a sample value of the right shape ("G-XXXXXXX"), when one helps |
fields[].key | body | string | — | the camelCase key on both the connect body and the stored config |
fields[].label | body | string | — | human label for the console card's input |
fields[].required | body | boolean | — | when true, a connect that leaves it empty is refused 400 |
live | body | boolean | — | Live is whether a credential resolves RIGHT NOW: a KMS-sealed secret for this org, else the integrations connection named by the platform's Fallback, else no… |
name | body | string | — | the platform's display name ("Google Analytics 4") |
pixel | body | boolean | — | Pixel is whether the hosted tag can inject a browser pixel for this platform, so a console offers a per-SITE pixel input for exactly these. |
platform | body | string | — | the platform slug, and the path segment every route addresses it by |
secrets | body | string[] | — | Secrets are the KMS secret NAMES this platform custodies for the org — names only, never values. |
Failure carries the platform error shape — see Errors.
Examples
hanzo destinations get <platform>import { Configuration, DestinationApi } from 'hanzoai';
const api = new DestinationApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDestinationByPlatform({ platform: 'platform' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import DestinationApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DestinationApi(client).get_destination_by_platform(platform='platform')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.DestinationAPI.GetDestinationByPlatform(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, destination_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = destination_api::get_destination_by_platform(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DestinationApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new DestinationApi(client).getDestinationByPlatform();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/destination/<platform> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches destination through the destinations tool, which names its 5 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_destinations"
}
}
}'How is this guide?