search-customers-request.md

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
cursor	string | undefined	Optional	Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. For more information, see Pagination.
limit	bigint | undefined	Optional	The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is invalid, Square returns a 400 VALUE_TOO_LOW or 400 VALUE_TOO_HIGH error. The default value is 100. For more information, see Pagination. Constraints: >= 1, <= 100
query	CustomerQuery | undefined	Optional	Represents a query (including filtering criteria, sorting criteria, or both) used to search for customer profiles.

Example (as 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"
    }
  }
}