Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Lists existing account pools.

get/v2/domains/{domainIdentifier}/account-pools

Path parameters

domainIdentifierstring required

The ID of the domain where exsting account pools are to be listed.

Query parameters

namestring password

The name of the account pool to be listed.

sortBy'NAME'

The sort by mechanism in which the existing account pools are to be listed.

sortOrder'ASCENDING' | 'DESCENDING'

The sort order in which the existing account pools are to be listed.

nextTokenstring

When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.

maxResultsinteger

The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAccountPools to list the next set of account pools.

Response

Success

nextTokenstring

When the number of account pools is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.