Amazon Chime
API Reference (API Version 2018-05-01)


Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

Request Syntax

GET /console/accounts?max-results=MaxResults&name=Name&next-token=NextToken&user-email=UserEmail HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.


The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 200.


Amazon Chime account name prefix with which to filter results.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: .*\S.*


The token to use to retrieve the next page of results.


User email address with which to filter results.

Pattern: .+@.+\..+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Accounts": [ { "AccountId": "string", "AccountType": "string", "AwsAccountId": "string", "CreatedTimestamp": number, "DefaultLicense": "string", "Name": "string", "SupportedLicenses": [ "string" ] } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


List of Amazon Chime accounts and account details.

Type: Array of Account objects


The token to use to retrieve the next page of results.

Type: String


For information about the errors that are common to all actions, see Common Errors.


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.

HTTP Status Code: 403


One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: