Hanzo AI
OpenapiProvider

Get provider

Returns ONE provider with this org's connection status — the same view list carries, for a single id.

GET /v1/provider/{provider}

Addresshttps://api.hanzo.ai/v1/provider/{provider}
MethodGET
Operationget_provider_by_provider
AuthAuthorization: Bearer $HANZO_API_KEY

Returns ONE provider with this org's connection status — the same view list carries, for a single id. An unknown id is 404, and so is a user-plane provider: the org surface never resolves one.

Request

1 field.

FieldInTypeRequiredDescription
providerpathstringyesProvider is the registry id of the connector — "slack", "github", "cloudflare".

Response

StatusBodyMeaning
200provider.providerViewok
defaultproblem-detailsrefused

200 body — 17 fields.

FieldInTypeAlwaysDescription
availablebodybooleanAvailable is whether THIS DEPLOYMENT has the provider's app credentials, so connect can succeed.
categorybodystringCategory groups the card ("Communication", "Developer", "Marketing").
connectedbodybooleanConnected is whether this org has a live connection to the provider.
connectionbodyprovider.connectionView
connection.accountbodystringAccount is the human label of the connected third-party account (the Slack team name, the GitHub org login).
connection.connectedAtbodystringConnectedAt is when the connection was last (re)established, RFC 3339 UTC.
connection.expiresAtbodystringExpiresAt is when the access token expires, RFC 3339 UTC; empty for a credential that does not expire.
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.
connection.idbodystringID is provider + ":" + label, the address every connection route takes.
connection.labelbodystringLabel is the caller's own name for this connection ("default", "work").
connection.providerbodystringProvider is the connected provider's registry id.
connection.scopesbodystring[]Scopes are the permissions the provider granted.
descriptionbodystringDescription is the one-line pitch the console card shows.
idbodystringID is the provider's registry id and the :provider path segment ("slack").
modesbodystring[]Modes are the ways this provider can be connected, derived from what it actually declares — "managed", "oauth", "apikey", "device", "mcp".
namebodystringName is the provider's display name ("Slack").
scopesbodystring[]Scopes are the permissions a connection will ask for.

Failure carries the platform error shape — see Errors.

Examples

hanzo provider get <provider>

Provider API · All Hanzo APIs · Interactive reference

How is this guide?

On this page