Hanzo
OpenapiChannels

Returns the caller org's access policy for one channel: whether DMs are…

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/channels/allowlist

Addresshttps://api.hanzo.ai/v1/channels/allowlist
MethodGET
Operationget_channels_allowlist
AuthAuthorization: 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.

FieldInTypeRequiredDescription
channelquerystringChannel is the transport to read: discord, slack, teams or telegram.

Response

StatusBodyMeaning
200allowlistViewok

200 body — 8 fields.

FieldInTypeAlwaysDescription
accessGroupsbodyobjectAccessGroups is the org's named sender sets, as group name -> channel -> member entries, held once for the whole org.
accessGroups.*bodyobject
accessGroups.*.*bodystring[]
dmbodystring[]DM is the CONFIG-managed DM allow entries — the list PUT /v1/channels/allowlist owns and replaces wholesale.
dmPolicybodystringDMPolicy decides every inbound DIRECT message, defaulting to "pairing" when the org has never set one.
groupbodystring[]Group is the CONFIG-managed group allow entries, consulted only while GroupPolicy is "allowlist".
groupPolicybodystringGroupPolicy decides every inbound GROUP or THREAD message — a thread is a group surface — defaulting to "open". "open" admits every sender in the room.
pairedbodystring[]Paired is the senders admitted by PAIRING — the entries POST /v1/channels/pairing/approve minted, DM scope only.

Failure carries the platform error shape — see Errors.

Examples

hanzo channels allowlist get

Channels API · All Hanzo APIs · Interactive reference

How is this guide?

On this page