Contents

---
title: SearchRequest
---
## PureCloud::SearchRequest

## Properties

|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **sort_order** | **String** | The sort order for results | [optional] |
| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
| **page_size** | **Integer** | The number of results per page | [optional] |
| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
| **return_fields** | **Array<String>** | A List of strings containing the resource field paths that you want to return | [optional] |
| **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
| **types** | **Array<String>** | Resource domain type to search | |
| **query** | [**Array<SearchCriteria>**](SearchCriteria.html) | The search criteria | [optional] |
| **aggregations** | [**Array<SearchAggregation>**](SearchAggregation.html) | Aggregation criteria | [optional] |
{: class="table table-striped"}

Version data entries

16 entries across 16 versions & 1 rubygems

Version	Path
purecloud-0.68.1	doc_out/SearchRequest.html.md
purecloud-0.67.1	doc_out/SearchRequest.html.md
purecloud-0.66.1	doc_out/SearchRequest.html.md
purecloud-0.65.1	doc_out/SearchRequest.html.md
purecloud-0.64.1	doc_out/SearchRequest.html.md
purecloud-0.63.1	doc_out/SearchRequest.html.md
purecloud-0.62.1	doc_out/SearchRequest.html.md
purecloud-0.61.1	doc_out/SearchRequest.html.md
purecloud-0.60.1	doc_out/SearchRequest.html.md
purecloud-0.59.1	doc_out/SearchRequest.html.md
purecloud-0.58.1	doc_out/SearchRequest.html.md
purecloud-0.57.1	doc_out/SearchRequest.html.md
purecloud-0.56.1	doc_out/SearchRequest.html.md
purecloud-0.55.1	doc_out/SearchRequest.html.md
purecloud-0.54.1	doc_out/SearchRequest.html.md
purecloud-0.53.1	doc_out/SearchRequest.html.md