List allowlist

Returns the caller org's access policy for one channel: whether DMs are pairing-gated, allowlisted or open, whether group rooms are open, allowlisted or…

GET /v1/channel/allowlist

Channel → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/channel/allowlist`
Method	`GET`
Operation	`get_channel_allowlist`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns the caller org's access policy for one channel: whether DMs are pairing-gated, allowlisted or open, whether group rooms are open, allowlisted or disabled, the config-managed DM and group allow entries, the senders approved through PAIRING (read-only here), and the org's named access groups. An unknown channel is a 404.

Request

1 field.

Field	In	Type	Required	Description
`channel`	query	string	—	Channel is the transport to read: discord, github, linear, slack, teams, telegram or whatsapp.

Response

Status	Body	Meaning
`200`	channel.allowlistView	ok
`default`	problem-details	refused

200 body — 8 fields.

Field	In	Type	Always	Description
`accessGroups`	body	object	—	AccessGroups is the org's named sender sets, as group name -> channel -> member entries, held once for the whole org.
`accessGroups.*`	body	object	—
`accessGroups..`	body	string[]	—
`dm`	body	string[]	—	DM is the CONFIG-managed DM allow entries — the list PUT /v1/channel/allowlist owns and replaces wholesale.
`dmPolicy`	body	string	—	DMPolicy decides every inbound DIRECT message, defaulting to "pairing" when the org has never set one.
`group`	body	string[]	—	Group is the CONFIG-managed group allow entries, consulted only while GroupPolicy is "allowlist".
`groupPolicy`	body	string	—	GroupPolicy decides every inbound GROUP or THREAD message — a thread is a group surface — defaulting to "open". "open" admits every sender in the room.
`paired`	body	string[]	—	Paired is the senders admitted by PAIRING — the entries POST /v1/channel/pairing/approve minted, DM scope only.

Failure carries the platform error shape — see Errors.

Examples

hanzo channel allowlist get

import { Configuration, ChannelApi } from 'hanzoai';

const api = new ChannelApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getChannelAllowlist();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ChannelApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ChannelApi(client).get_channel_allowlist()

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

resp, _, err := client.ChannelAPI.GetChannelAllowlist(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, channel_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = channel_api::get_channel_allowlist(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ChannelApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new ChannelApi(client).getChannelAllowlist();

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/channel/allowlist \
  -H "Authorization: Bearer $HANZO_API_KEY"

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

Channel API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page