Object Index
You are viewing an old version of the API
CustomerFilter
Object Index
Represents a set of CustomerQuery
filters used to limit the set of
customers returned by the SearchCustomers endpoint.
Properties
Name | Description |
---|---|
creation_
|
A filter to select customers based on their creation source. |
created_
|
A filter to select customers based on when they were created. |
updated_
|
A filter to select customers based on when they were updated. |
email_
|
A filter to select customers by their email address visible to the seller. This filter is case-insensitive. For exact matching, this
filter causes the search to return customer profiles
whose For fuzzy matching,
this filter causes the search to return customer profiles
whose |
phone_
|
A filter to select customers by their phone numbers visible to the seller. This filter is case-insensitive. For exact matching,
this filter causes the search to return customers whose phone number
matches the specified query expression. The number in the query must be of an E.164-compliant
form. In particular, it must include the leading For fuzzy matching,
this filter causes the search to return customers whose phone number matches partially
the token or tokens provided in the query expression. For example, if the search query contains
|
reference_
|
A filter to select customers by their reference IDs. This filter is case-insensitive. Exact matching of a customer's reference ID against a query's reference ID is evaluated as an exact match between two strings, character by character in the given order. Fuzzy matching
of stored reference IDs against queried reference IDs works
exactly the same as fuzzy matching on email addresses. Non-alphanumeric characters
are replaced by spaces to tokenize stored and queried reference IDs. A match is found
if a tokenized stored reference ID contains all tokens specified in any order in the query. For example,
a query of |
group_
|
A filter to select customers based on their group membership. The
You can use any combination of these If any of the search conditions are not met, including when an invalid or non-existent group ID is provided, the result is an empty list. You can use the You cannot use the |