GET

/accounts/{accountId}/users

http://service.chime.aws.amazon.com/accounts/{accountId}/users

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

Access Token Required: API Key

Path Parameters

accountIdstringrequired

The Amazon Chime account ID.

Query Params

user-emailstring

Optional. The user email address used to filter results. Maximum 1.

user-typestring

The user type.

Allowed:

max-resultsinteger

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

next-tokenstring

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

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/accounts/{accountId}/users' \
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}