v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14191644620.9 KB

Lists all channel memberships in a 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}/memberships

Path parameters

channelArnstring required

The maximum number of channel memberships that you want returned.

Query parameters

type'DEFAULT' | 'HIDDEN'

The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned.

max-resultsinteger

The maximum number of channel memberships that you want returned.

next-tokenstring password

The token passed by previous API calls until all requested channel memberships 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 channel memberships are returned.