v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Allows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

This operation isn't supported for AppInstanceUsers with a large number of memberships.

post/channels#operation=search

Query parameters

max-resultsinteger

The maximum number of channels that you want returned.

next-tokenstring password

The token returned from previous API requests until the number of channels is reached.

operation'search' required

Headers

x-amz-chime-bearerstring

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

Request body

Response

Success

NextTokenstring password

The token returned from previous API responses until the number of channels is reached.