Hanzo
OpenapiDestination

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

Addresshttps://api.hanzo.ai/v1/destination
MethodGET
Operationget_destination
AuthAuthorization: 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

StatusBodyMeaning
200destinationListok

200 body — 17 fields.

FieldInTypeAlwaysDescription
destinationsbodyDestinationStatus[]Destinations is one card per registered platform, in slug order.
destinations[].accountbodystringAccount is the operator's own label for the connected account, as supplied on connect.
destinations[].categorybodystringgroups the card: Analytics | Advertising
destinations[].configbodyobjectConfig is the org's stored NON-SECRET configuration — the measurement/pixel ids keyed by DestinationField.Key.
destinations[].config.*bodystring
destinations[].connectedbodybooleanConnected is true when this org has a stored row for the platform — it has been configured here at least once.
destinations[].enabledbodybooleanEnabled is whether the fan-out forwards to this destination.
destinations[].fieldsbodyDestinationField[]Fields are the non-secret inputs this platform needs, which the console card renders and the connect body fills.
destinations[].fields[].examplebodystringa sample value of the right shape ("G-XXXXXXX"), when one helps
destinations[].fields[].keybodystringthe camelCase key on both the connect body and the stored config
destinations[].fields[].labelbodystringhuman label for the console card's input
destinations[].fields[].requiredbodybooleanwhen true, a connect that leaves it empty is refused 400
destinations[].livebodybooleanLive 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[].namebodystringthe platform's display name ("Google Analytics 4")
destinations[].pixelbodybooleanPixel 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[].platformbodystringthe platform slug, and the path segment every route addresses it by
destinations[].secretsbodystring[]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 list

Destination API · All Hanzo APIs · Interactive reference

How is this guide?

On this page