Sha256: 195f2f8f1a4f0c3e074da563d63279949a5c968e9c40e257ec6198e08ca22a0e

Contents?: true

Size: 1.09 KB

Versions: 10

Compression:

Stored size: 1.09 KB

Contents

# SquareConnect::SearchCustomersRequest

### Description

Defines the fields included in the request body for the [SearchCustomers](#endpoint-searchcustomer) endpoint.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.  See [Paginating results](#paginatingresults) for more information. | [optional] 
**limit** | **Integer** | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored. | [optional] 
**query** | [**CustomerQuery**](CustomerQuery.md) | Query customers based on the given conditions and sort order. Calling SearchCustomers without an explicit query parameter will return all customers ordered alphabetically based on `given_name` and `family_name`. | [optional] 


Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
square_connect-2.20190213.0.274 docs/SearchCustomersRequest.md
square_connect-2.20181212.0.267 docs/SearchCustomersRequest.md
square_connect-2.20181205.0.263 docs/SearchCustomersRequest.md
square_connect-2.20180918.1.251 docs/SearchCustomersRequest.md
square_connect-2.20180918.0.244 docs/SearchCustomersRequest.md
square_connect-2.20180712.2.237 docs/SearchCustomersRequest.md
square_connect-2.20180712.1.234 docs/SearchCustomersRequest.md
square_connect-2.20180712.1.228 docs/SearchCustomersRequest.md
square_connect-2.20180712.0.224 docs/SearchCustomersRequest.md
square_connect-2.9.0.220 docs/SearchCustomersRequest.md