Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Lists all channel memberships in a channel.

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.

If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

get/channels/{channelArn}/memberships#x-amz-chime-bearer

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 returned as part of <code>ListChannelMemberships</code> if no type is specified. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>.

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.

sub-channel-idstring
<p>The ID of the SubChannel in the request.</p> <note> <p>Only required when listing a user's memberships in a particular sub-channel of an elastic channel.</p> </note>

Headers

x-amz-chime-bearerstring required

The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> 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.