---
title: "POST /domains/{domainId}/cases-search"
method: POST
path: "/domains/{domainId}/cases-search"
---

# POST /domains/{domainId}/cases-search

`POST /domains/{domainId}/cases-search`

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`.

## Path parameters

- `domainId` string, required

## Request body

- object
  - `maxResults` integer — The maximum number of cases to return. When no value is provided, 25 is the default.
  - `nextToken` string — 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.
  - `searchTerm` string — A word or phrase used to perform a quick search.
  - `filter` object — A filter for cases. Only one value can be provided.
    - `field` object — A list of fields to filter on.
      - `equalTo` object — Object containing field identifier and value information.
        - `id` string, required — Unique identifier of a field.
        - `value` object, required — Union of potential field value types.
          - `stringValue` string — String value type.
          - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
          - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
          - `emptyValue` object — An empty value.
          - `userArnValue` string — Represents the user that performed the audit.
      - `contains` object — Object containing field identifier and value information.
        - `id` string, required — Unique identifier of a field.
        - `value` object, required — Union of potential field value types.
          - `stringValue` string — String value type.
          - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
          - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
          - `emptyValue` object — An empty value.
          - `userArnValue` string — Represents the user that performed the audit.
      - `greaterThan` object — Object containing field identifier and value information.
        - `id` string, required — Unique identifier of a field.
        - `value` object, required — Union of potential field value types.
          - `stringValue` string — String value type.
          - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
          - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
          - `emptyValue` object — An empty value.
          - `userArnValue` string — Represents the user that performed the audit.
      - `greaterThanOrEqualTo` object — Object containing field identifier and value information.
        - `id` string, required — Unique identifier of a field.
        - `value` object, required — Union of potential field value types.
          - `stringValue` string — String value type.
          - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
          - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
          - `emptyValue` object — An empty value.
          - `userArnValue` string — Represents the user that performed the audit.
      - `lessThan` object — Object containing field identifier and value information.
        - `id` string, required — Unique identifier of a field.
        - `value` object, required — Union of potential field value types.
          - `stringValue` string — String value type.
          - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
          - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
          - `emptyValue` object — An empty value.
          - `userArnValue` string — Represents the user that performed the audit.
      - `lessThanOrEqualTo` object — Object containing field identifier and value information.
        - `id` string, required — Unique identifier of a field.
        - `value` object, required — Union of potential field value types.
          - `stringValue` string — String value type.
          - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
          - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
          - `emptyValue` object — An empty value.
          - `userArnValue` string — Represents the user that performed the audit.
    - `not` CaseFilter — A filter for cases. Only one value can be provided.
      - `field` object — A list of fields to filter on.
        - `equalTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `contains` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `greaterThan` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `greaterThanOrEqualTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `lessThan` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `lessThanOrEqualTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
      - `not` CaseFilter — recursive
      - `tag` object — A list of tags to filter on.
        - `equalTo` object — Object containing tag key and value information.
          - `key` string — The tag key in the tag filter value.
          - `value` string — The tag value in the tag filter value.
      - `andAll` CaseFilter[] — Provides "and all" filtering.
      - `orAll` CaseFilter[] — Provides "or all" filtering.
    - `tag` object — A list of tags to filter on.
      - `equalTo` object — Object containing tag key and value information.
        - `key` string — The tag key in the tag filter value.
        - `value` string — The tag value in the tag filter value.
    - `andAll` CaseFilter[] — Provides "and all" filtering.
      - `field` object — A list of fields to filter on.
        - `equalTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `contains` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `greaterThan` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `greaterThanOrEqualTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `lessThan` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `lessThanOrEqualTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
      - `not` CaseFilter — recursive
      - `tag` object — A list of tags to filter on.
        - `equalTo` object — Object containing tag key and value information.
          - `key` string — The tag key in the tag filter value.
          - `value` string — The tag value in the tag filter value.
      - `andAll` CaseFilter[] — Provides "and all" filtering.
      - `orAll` CaseFilter[] — Provides "or all" filtering.
    - `orAll` CaseFilter[] — Provides "or all" filtering.
      - `field` object — A list of fields to filter on.
        - `equalTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `contains` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `greaterThan` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `greaterThanOrEqualTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `lessThan` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
        - `lessThanOrEqualTo` object — Object containing field identifier and value information.
          - `id` string, required — Unique identifier of a field.
          - `value` object, required — Union of potential field value types.
            - `stringValue` string — String value type.
            - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
            - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
            - `emptyValue` object — An empty value.
            - `userArnValue` string — Represents the user that performed the audit.
      - `not` CaseFilter — recursive
      - `tag` object — A list of tags to filter on.
        - `equalTo` object — Object containing tag key and value information.
          - `key` string — The tag key in the tag filter value.
          - `value` string — The tag value in the tag filter value.
      - `andAll` CaseFilter[] — Provides "and all" filtering.
      - `orAll` CaseFilter[] — Provides "or all" filtering.
  - `sorts` Sort[] — A list of sorts where each sort specifies a field and their sort order to be applied to the results.
    - `fieldId` string, required — Unique identifier of a field.
    - `sortOrder` 'Asc' | 'Desc', required — A structured set of sort terms
  - `fields` FieldIdentifier[] — The list of field identifiers to be returned as part of the response.
    - `id` string, required — Unique identifier of a field.

## Response `200`

Success

- SearchCasesResponse
  - `nextToken` string — The token for the next set of results. This is null if there are no more results to return.
  - `cases` SearchCasesResponseItem[], required — A list of case documents where each case contains the properties <code>CaseId</code> and <code>Fields</code> where each field is a complex union structure.
    - `caseId` string, required — A unique identifier of the case.
    - `templateId` string, required — A unique identifier of a template.
    - `fields` FieldValue[], required — List of case field values.
      - `id` string, required — Unique identifier of a field.
      - `value` object, required — Union of potential field value types.
        - `stringValue` string — String value type.
        - `doubleValue` number, double — Can be either null, or have a Double number value type. Only one value can be provided.
        - `booleanValue` boolean — Can be either null, or have a Boolean value type. Only one value can be provided.
        - `emptyValue` object — An empty value.
        - `userArnValue` string — Represents the user that performed the audit.
    - `tags` object — A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
  - `totalCount` integer — The total number of cases that matched the search criteria.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ValidationException
- `483` — ThrottlingException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/connectcases.md) · [All operations](https://skmtc.net/aws/apis/connectcases/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/connectcases/versions/2533502f9155/schema)