Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Search Customers Request
Defines the fields that are included in the request body of a request to the
`SearchCustomers` endpoint.
## Structure
`SearchCustomersRequest`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `cursor` | `?string` | Optional | Include the pagination cursor in subsequent calls to this endpoint to retrieve<br>the next set of results associated with the original query.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
| `limit` | `?int` | Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.<br>The limit is ignored if it is less than the minimum or greater than the maximum value. The default value is 100.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).<br>**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
| `query` | [`?CustomerQuery`](/doc/models/customer-query.md) | Optional | Represents a query (including filtering criteria, sorting criteria, or both) used to search<br>for customer profiles. | getQuery(): ?CustomerQuery | setQuery(?CustomerQuery query): void |
## Example (as JSON)
```json
{
"limit": 2,
"query": {
"filter": {
"created_at": {
"end_at": "2018-02-01T00:00:00-00:00",
"start_at": "2018-01-01T00:00:00-00:00"
},
"creation_source": {
"rule": "INCLUDE",
"values": [
"THIRD_PARTY"
]
},
"email_address": {
"fuzzy": "example.com"
},
"group_ids": {
"all": [
"545AXB44B4XXWMVQ4W8SBT3HHF"
]
}
},
"sort": {
"field": "CREATED_AT",
"order": "ASC"
}
}
}
```