Reports every destination this deployment can forward to, each with the caller…
Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled,…
GET /v1/destination
| Address | https://api.hanzo.ai/v1/destination |
| Method | GET |
| Operation | get_destination |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.
Request
GET /v1/destination takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | destinationList | ok |
200 body — 17 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
destinations | body | DestinationStatus[] | — | Destinations is one card per registered platform, in slug order. |
destinations[].account | body | string | — | Account is the operator's own label for the connected account, as supplied on connect. |
destinations[].category | body | string | — | groups the card: Analytics | Advertising |
destinations[].config | body | object | — | Config is the org's stored NON-SECRET configuration — the measurement/pixel ids keyed by DestinationField.Key. |
destinations[].config.* | body | string | — | |
destinations[].connected | body | boolean | — | Connected is true when this org has a stored row for the platform — it has been configured here at least once. |
destinations[].enabled | body | boolean | — | Enabled is whether the fan-out forwards to this destination. |
destinations[].fields | body | DestinationField[] | — | Fields are the non-secret inputs this platform needs, which the console card renders and the connect body fills. |
destinations[].fields[].example | body | string | — | a sample value of the right shape ("G-XXXXXXX"), when one helps |
destinations[].fields[].key | body | string | — | the camelCase key on both the connect body and the stored config |
destinations[].fields[].label | body | string | — | human label for the console card's input |
destinations[].fields[].required | body | boolean | — | when true, a connect that leaves it empty is refused 400 |
destinations[].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… |
destinations[].name | body | string | — | the platform's display name ("Google Analytics 4") |
destinations[].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. |
destinations[].platform | body | string | — | the platform slug, and the path segment every route addresses it by |
destinations[].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 listimport { Configuration, DestinationApi } from 'hanzoai';
const api = new DestinationApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDestination();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()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.DestinationAPI.GetDestination(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(&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).getDestination();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 \
-H "Authorization: Bearer $HANZO_API_KEY"Tool destinations, op get_destination — 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": "destinations",
"arguments": {
"op": "get_destination",
"input": {}
}
}
}'How is this guide?