Hanzo
OpenapiIntegrations

Returns every registered integration provider together with THIS org's…

Returns every registered integration provider together with THIS org's connection status for it — the catalog the console's Integrations page renders.

GET /v1/integrations

Addresshttps://api.hanzo.ai/v1/integrations
MethodGET
Operationget_integrations
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every registered integration provider together with THIS org's connection status for it — the catalog the console's Integrations page renders. Org-authed: a caller with no validated principal is 403, because the status is per-org and there is no org-less answer. User-plane providers (the /v1/integrations/connectors surface) are omitted; the two planes are disjoint.

Request

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

Response

StatusBodyMeaning
200listOutok

200 body — 12 fields.

FieldInTypeAlwaysDescription
providersbodyproviderView[]Providers is the whole catalog.
providers[].availablebodybooleanAvailable is whether THIS DEPLOYMENT has the provider's app credentials, so connect can succeed.
providers[].categorybodystringCategory groups the card ("Communication", "Developer", "Marketing").
providers[].connectedbodybooleanConnected is whether this org has a live connection to the provider.
providers[].connectionbodyconnectionView
providers[].connection.accountbodystringAccount is the human label of the connected third-party account (the Slack team name, the GitHub org login).
providers[].connection.connectedAtbodystringConnectedAt is when the connection was last (re)established, RFC 3339 UTC.
providers[].connection.externalIdbodystringExternalID is the provider's own id for the account (Slack team.id, GitHub installation_id) — the value inbound webhooks are mapped back to this org by.
providers[].connection.scopesbodystring[]Scopes are the permissions the provider granted.
providers[].descriptionbodystringDescription is the one-line pitch the console card shows.
providers[].idbodystringID is the provider's registry id and the :provider path segment ("slack").
providers[].namebodystringName is the provider's display name ("Slack").

Failure carries the platform error shape — see Errors.

Examples

hanzo integrations list

Integrations API · All Hanzo APIs · Interactive reference

How is this guide?

On this page