List groups

Reads the invite link of a group this org's number owns.

GET /v1/provider/whatsapp/groups

Provider → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/provider/whatsapp/groups`
Method	`GET`
Operation	`get_provider_whatsapp_groups`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reads the invite link of a group this org's number owns.

Org admin, for the same reason creating one is: the link admits anyone who holds it.

Request

1 field.

Field	In	Type	Required	Description
`group`	query	string	—	Group is the group id returned when the group was created.

Response

Status	Body	Meaning
`200`	provider.whatsappGroupOut	ok
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`id`	body	string	—	ID is the group id.
`invite_link`	body	string	—	InviteLink is the link a person opens to join.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo provider whatsapp groups get

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

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

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ProviderAPI.GetProviderWhatsappGroups(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_whatsapp_groups(&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).getProviderWhatsappGroups();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were 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/whatsapp/groups \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches provider through the provider tool, which names its 41 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_connections"
         }
       }
     }'

Provider API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousList callback — GET /v1/provider/twitter/callback NextList webhook