v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14191644620.9 KB

Lists all the users banned from a particular channel.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

get/channels/{channelArn}/bans

Path parameters

channelArnstring required

The ARN of the channel.

Query parameters

max-resultsinteger

The maximum number of bans that you want returned.

next-tokenstring password

The token passed by previous API calls until all requested bans are returned.

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

x-amz-chime-bearerstring

The <code>AppInstanceUserArn</code> of the user that makes the API call.

Response

Success

ChannelArnstring

The ARN of the channel.

NextTokenstring password

The token passed by previous API calls until all requested bans are returned.