Get provider

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

GET /v1/provider/{provider}

Provider → · All API references → · Get started →

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 — 54 fields.

Field	In	Type	Always	Description
`actions`	body	provider.opView[]	—	Actions are what the connector can be asked to do, by a flow step or an agent (POST /v1/provider/{provider}/run when Runnable).
`actions[].description`	body	string	—	Description says what it does.
`actions[].displayName`	body	string	—	DisplayName is what the card calls it.
`actions[].name`	body	string	—	Name is the action's id — what a run or a flow step names.
`actions[].props`	body	provider.PropSpec[]	—	Props are its inputs — what POST /v1/provider/{provider}/run takes as input.
`actions[].props[].description`	body	string	—	Description says what the value is.
`actions[].props[].displayName`	body	string	—	DisplayName is what a form calls it.
`actions[].props[].name`	body	string	—	Name is the input's key in the action's input object.
`actions[].props[].required`	body	boolean	—	Required is whether the action refuses to run without it.
`actions[].props[].type`	body	string	—	Type is the JSON type the value takes: string\|number\|boolean\|object\|array.
`app`	body	string	—	App names the OAuth app registration its sign-in uses ("GOOGLE"), for a connector whose sign-in awaits one.
`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").
`checks`	body	boolean	—	Checks is whether a pasted credential is checked with the provider before it is stored.
`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.
`fields`	body	provider.Field[]	—	Fields is the form a credential connector asks for.
`fields[].default`	body	string	—	Default is what an empty input stands for.
`fields[].help`	body	string	—	Help is the connector's own instruction for finding the value.
`fields[].label`	body	string	—	Label is what the input is called on the form.
`fields[].name`	body	string	—	Name is the key the value is submitted under.
`fields[].options`	body	provider.FieldOption[]	—	Options are the values a choice field accepts.
`fields[].options[].label`	body	string	—	Label is what the choice is called.
`fields[].options[].value`	body	string	—	Value is what submitting it sends.
`fields[].required`	body	boolean	—	Required is whether the form refuses to submit without it.
`fields[].secret`	body	boolean	—	Secret masks the input; its value is sealed and never read back.
`fields[].type`	body	string	—	Type is "number", "boolean" or "text" (multi-line) when the value is not a single line of text.
`id`	body	string	—	ID is the provider's registry id and the :provider path segment ("slack").
`kind`	body	string	—	Kind is how a reader connects it NOW: "oauth" (send the browser to the provider), "credential" (fill in Fields), "device" (enter a code), or "none" (nothing to connect — ready, or not connectable here; Note says).
`logo`	body	string	—	Logo is where the connector's logo is served.
`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").
`note`	body	string	—	Note says why the connector cannot be connected here, when it cannot.
`runnable`	body	boolean	—	Runnable is whether its actions run on this deployment.
`scopes`	body	string[]	—	Scopes are the permissions a connection will ask for.
`triggers`	body	provider.opView[]	—	Triggers are the events a flow can start on.
`triggers[].description`	body	string	—	Description says what it does.
`triggers[].displayName`	body	string	—	DisplayName is what the card calls it.
`triggers[].name`	body	string	—	Name is the action's id — what a run or a flow step names.
`triggers[].props`	body	provider.PropSpec[]	—	Props are its inputs — what POST /v1/provider/{provider}/run takes as input.
`triggers[].props[].description`	body	string	—	Description says what the value is.
`triggers[].props[].displayName`	body	string	—	DisplayName is what a form calls it.
`triggers[].props[].name`	body	string	—	Name is the input's key in the action's input object.
`triggers[].props[].required`	body	boolean	—	Required is whether the action refuses to run without it.
`triggers[].props[].type`	body	string	—	Type is the JSON type the value takes: string\|number\|boolean\|object\|array.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo provider get <provider>

.ts

.py

.go

.rs

.java

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();

curl https://api.hanzo.ai/v1/provider/<provider> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool provider, op get_provider_by_provider — 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": "provider",
         "arguments": {
           "op": "get_provider_by_provider",
           "input": {
             "provider": "<provider>"
           }
         }
       }
     }'

Provider API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList logo NextList callback — GET /v1/provider/discord/link/callback