GET

/channels#app-instance-arn

http://service.chime.aws.amazon.com/channels#app-instance-arn

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality & restrictions <ul> <li> Use privacy = <code>PUBLIC</code> to retrieve all public channels in the account. </li> <li> Only an <code>AppInstanceAdmin</code> can set privacy = <code>PRIVATE</code> to list the private channels in an account. </li> </ul> <note> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </note>

Access Token Required: API Key

Query Params

app-instance-arnstringrequired

The ARN of the <code>AppInstance</code>.

privacystring

The privacy setting. <code>PUBLIC</code> retrieves all the public channels. <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code> can retrieve private channels.

Allowed:

max-resultsinteger

The maximum number of channels that you want to return.

next-tokenstring

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

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://service.chime.aws.amazon.com/channels#app-instance-arn' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}