Get provider
Returns ONE provider with this org's connection status — the same view list carries, for a single id.
GET /v1/provider/{provider}
| Address | https://api.hanzo.ai/v1/provider/{provider} |
| Method | GET |
| Operation | get_provider_by_provider |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes | Provider is the registry id of the connector — "slack", "github", "cloudflare". |
Response
| Status | Body | Meaning |
|---|---|---|
200 | provider.providerView | ok |
default | problem-details | refused |
200 body — 17 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
available | body | boolean | — | Available is whether THIS DEPLOYMENT has the provider's app credentials, so connect can succeed. |
category | body | string | — | Category groups the card ("Communication", "Developer", "Marketing"). |
connected | body | boolean | — | Connected is whether this org has a live connection to the provider. |
connection | body | provider.connectionView | — | |
connection.account | body | string | — | Account is the human label of the connected third-party account (the Slack team name, the GitHub org login). |
connection.connectedAt | body | string | — | ConnectedAt is when the connection was last (re)established, RFC 3339 UTC. |
connection.expiresAt | body | string | — | ExpiresAt is when the access token expires, RFC 3339 UTC; empty for a credential that does not expire. |
connection.externalId | body | string | — | ExternalID 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.id | body | string | — | ID is provider + ":" + label, the address every connection route takes. |
connection.label | body | string | — | Label is the caller's own name for this connection ("default", "work"). |
connection.provider | body | string | — | Provider is the connected provider's registry id. |
connection.scopes | body | string[] | — | Scopes are the permissions the provider granted. |
description | body | string | — | Description is the one-line pitch the console card shows. |
id | body | string | — | ID is the provider's registry id and the :provider path segment ("slack"). |
modes | body | string[] | — | Modes are the ways this provider can be connected, derived from what it actually declares — "managed", "oauth", "apikey", "device", "mcp". |
name | body | string | — | Name is the provider's display name ("Slack"). |
scopes | body | string[] | — | Scopes are the permissions a connection will ask for. |
Failure carries the platform error shape — see Errors.
Examples
hanzo provider get <provider>import { Configuration, ProviderApi } from 'hanzoai';
const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProviderByProvider({ provider: 'provider' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).get_provider_by_provider(provider='provider')cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ProviderAPI.GetProviderByProvider(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, provider_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = provider_api::get_provider_by_provider(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new ProviderApi(client).getProviderByProvider();The method above is the one at the current release of the document. [email protected] (npm) was 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/provider/<provider> \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for provider — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?