Hanzo
OpenapiChannels

Returns the pairing requests waiting for the caller org to approve — one per…

Returns the pairing requests waiting for the caller org to approve — one per person who messaged a connected bot on a channel whose DM policy is "pairing"…

GET /v1/channels/pairing

Addresshttps://api.hanzo.ai/v1/channels/pairing
MethodGET
Operationget_channels_pairing
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the pairing requests waiting for the caller org to approve — one per person who messaged a connected bot on a channel whose DM policy is "pairing" and who is not allowed yet. Each row carries the CODE an org admin passes to POST /v1/channels/pairing/approve. Expired requests are not returned. Codes are capability strings: they are shown here, and never logged.

Request

GET /v1/channels/pairing takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200pairingQueueok

200 body — 6 fields.

FieldInTypeAlwaysDescription
pendingbodypairingView[]Pending is every unexpired pairing request waiting on an org admin, each carrying the channel, the requesting sender and the code to approve it with.
pending[].channelbodystringChannel is the transport the request arrived on — discord, slack, teams or telegram — and half of what approval names.
pending[].codebodystringCode is the CAPABILITY that authorises the approval: eight characters from a 32-symbol uppercase alphabet (A-Z0-9 minus the confusables 0, O, 1 and I), minted…
pending[].createdAtbodyintegerCreatedAt is Unix SECONDS of FIRST contact: when the request was minted and the code sent.
pending[].lastSeenbodyintegerLastSeen is Unix SECONDS of the MOST RECENT message from this sender while the request has been pending.
pending[].senderbodystringSender is the transport-native user id waiting for access — the same identity inbox messages carry.

Failure carries the platform error shape — see Errors.

Examples

hanzo channels pairing get

Channels API · All Hanzo APIs · Interactive reference

How is this guide?

On this page