Searches the customer profiles associated with a Square account using one or more supported query filters.
Open in API Reference
Indicates whether to return the total count of matching customers in the count field of the response.
count
The default value is false.
false
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.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
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.
400 VALUE_TOO_LOW
400 VALUE_TOO_HIGH
The filtering and sorting criteria for the search request. If a query is not specified, Square returns all customer profiles ordered alphabetically by given_name and family_name.
given_name
family_name
// No response received yet.