Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443311204.0 KB

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.

post/domains/{domainId}/cases-search

Path parameters

domainIdstring required

The unique identifier of the Cases domain.

Request body

maxResultsinteger

The maximum number of cases to return. When no value is provided, 25 is the default.

nextTokenstring

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchTermstring

A word or phrase used to perform a quick search.

Response

Success

nextTokenstring

The token for the next set of results. This is null if there are no more results to return.

totalCountinteger

The total number of cases that matched the search criteria.