arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/SearchSquareCustomers.json
jottakka f2332a7682
[Moar][Rewrapping] Rewrapping tools (#653)
## Rewrapping

- Calendly
- Airtable
- Squareup
- PagerDuty
- Trello
- Miro

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-24 18:05:33 -03:00

1733 lines
204 KiB
JSON

{
"name": "SearchSquareCustomers",
"fully_qualified_name": "SquareupApi.SearchSquareCustomers@2.0.0",
"description": "Search customer profiles in a Square account.\n\nUse this tool to search for customer profiles in a Square account by applying various query filters. If no filters are provided, it returns all profiles sorted alphabetically by name.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "customer_search_filters",
"required": true,
"description": "A JSON object specifying the search criteria such as pagination, limit, query filters, sort, and count options for the customer search. Each field in the object allows further customization by providing specific filters or options regarding the customer profiles.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"cursor": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Include the pagination cursor in subsequent calls to this endpoint to retrieve\nthe next set of results associated with the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
},
"limit": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
},
"query": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"filter": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"creation_source": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"values": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The list of creation sources used as filtering criteria.\nSee [CustomerCreationSource](#type-customercreationsource) for possible values"
},
"rule": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"INCLUDE",
"EXCLUDE"
],
"properties": null,
"inner_properties": null,
"description": "Indicates whether customers should be included in, or excluded from,\nthe result set when they match the filtering criteria."
}
},
"inner_properties": null,
"description": "The creation source filter.\n\nIf one or more creation sources are set, customer profiles are included in,\nor excluded from, the result if they match at least one of the filter criteria."
},
"created_at": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
},
"updated_at": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
},
"email_address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"phone_number": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"reference_id": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"group_ids": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"all": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must be present on the field of the resource."
},
"any": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms where at least one of them must be present on the\nfield of the resource."
},
"none": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must not be present on the field the resource"
}
},
"inner_properties": null,
"description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field."
},
"custom_attribute": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"filters": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"key": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes)."
},
"filter": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"email": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"phone": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"text": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"selection": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"all": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must be present on the field of the resource."
},
"any": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms where at least one of them must be present on the\nfield of the resource."
},
"none": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must not be present on the field the resource"
}
},
"inner_properties": null,
"description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field."
},
"date": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
},
"number": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A decimal value indicating where the range starts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A decimal value indicating where the range ends."
}
},
"inner_properties": null,
"description": "Specifies a decimal number range."
},
"boolean": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A filter for a query based on the value of a `Boolean`-type custom attribute."
},
"address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"postal_code": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"country": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ZZ",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm)."
}
},
"inner_properties": null,
"description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute."
}
},
"inner_properties": null,
"description": "A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](entity:CustomAttribute)."
},
"updated_at": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
}
},
"description": "The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters."
}
},
"inner_properties": null,
"description": "The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](entity:CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute)."
},
"segment_ids": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"all": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must be present on the field of the resource."
},
"any": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms where at least one of them must be present on the\nfield of the resource."
},
"none": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must not be present on the field the resource"
}
},
"inner_properties": null,
"description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field."
}
},
"inner_properties": null,
"description": "Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results."
},
"sort": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"field": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"DEFAULT",
"CREATED_AT"
],
"properties": null,
"inner_properties": null,
"description": "Specifies customer attributes as the sort key to customer profiles returned from a search."
},
"order": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"DESC",
"ASC"
],
"properties": null,
"inner_properties": null,
"description": "The order (e.g., chronological or alphabetical) in which results from a request are returned."
}
},
"inner_properties": null,
"description": "Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results."
}
},
"inner_properties": null,
"description": "Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request."
},
"count": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether to return the total count of matching customers in the `count` field of the response.\n\nThe default value is `false`."
}
},
"inner_properties": null,
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details."
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
}
]
},
"output": {
"description": "Response from the API endpoint 'SearchCustomers'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": {
"provider_id": "arcade-squareup",
"provider_type": "oauth2",
"id": null,
"oauth2": {
"scopes": [
"CUSTOMERS_READ"
]
}
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.1.0",
"description": "Tools that enable LLMs to interact directly with the squareup API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://connect.squareup.com/v2/customers/search",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "requestBody",
"tool_parameter_name": "customer_search_filters",
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"cursor": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Include the pagination cursor in subsequent calls to this endpoint to retrieve\nthe next set of results associated with the original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
},
"limit": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\nIf the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
},
"query": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"filter": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"creation_source": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"values": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The list of creation sources used as filtering criteria.\nSee [CustomerCreationSource](#type-customercreationsource) for possible values"
},
"rule": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"INCLUDE",
"EXCLUDE"
],
"properties": null,
"inner_properties": null,
"description": "Indicates whether customers should be included in, or excluded from,\nthe result set when they match the filtering criteria."
}
},
"inner_properties": null,
"description": "The creation source filter.\n\nIf one or more creation sources are set, customer profiles are included in,\nor excluded from, the result if they match at least one of the filter criteria."
},
"created_at": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
},
"updated_at": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
},
"email_address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"phone_number": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"reference_id": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"group_ids": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"all": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must be present on the field of the resource."
},
"any": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms where at least one of them must be present on the\nfield of the resource."
},
"none": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must not be present on the field the resource"
}
},
"inner_properties": null,
"description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field."
},
"custom_attribute": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"filters": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"key": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes)."
},
"filter": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"email": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"phone": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"text": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"selection": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"all": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must be present on the field of the resource."
},
"any": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms where at least one of them must be present on the\nfield of the resource."
},
"none": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must not be present on the field the resource"
}
},
"inner_properties": null,
"description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field."
},
"date": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
},
"number": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A decimal value indicating where the range starts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A decimal value indicating where the range ends."
}
},
"inner_properties": null,
"description": "Specifies a decimal number range."
},
"boolean": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A filter for a query based on the value of a `Boolean`-type custom attribute."
},
"address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"postal_code": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"exact": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the exact filter to select customers whose attributes match exactly the specified query."
},
"fuzzy": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Use the fuzzy filter to select customers whose attributes match the specified query \nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \neach query token must be matched somewhere in the searched attribute. For single token queries, \nthis is effectively the same behavior as a partial match operation."
}
},
"inner_properties": null,
"description": "A filter to select customers based on exact or fuzzy matching of\ncustomer attributes against a specified query. Depending on the customer attributes, \nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both."
},
"country": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ZZ",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm)."
}
},
"inner_properties": null,
"description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute."
}
},
"inner_properties": null,
"description": "A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value \nof a customer-related [custom attribute](entity:CustomAttribute)."
},
"updated_at": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nstarts."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A datetime value in RFC 3339 format indicating when the time range\nends."
}
},
"inner_properties": null,
"description": "Represents a generic time range. The start and end values are\nrepresented in RFC 3339 format. Time ranges are customized to be\ninclusive or exclusive based on the needs of a particular endpoint.\nRefer to the relevant endpoint-specific documentation to determine\nhow time ranges are handled."
}
},
"description": "The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters."
}
},
"inner_properties": null,
"description": "The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter\nto search based on [custom attributes](entity:CustomAttribute) that are assigned to customer profiles. For more information, see\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute)."
},
"segment_ids": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"all": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must be present on the field of the resource."
},
"any": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms where at least one of them must be present on the\nfield of the resource."
},
"none": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of terms that must not be present on the field the resource"
}
},
"inner_properties": null,
"description": "A filter to select resources based on an exact field value. For any given\nvalue, the value can only be in one property. Depending on the field, either\nall properties can be set or only a subset will be available.\n\nRefer to the documentation of the field."
}
},
"inner_properties": null,
"description": "Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results."
},
"sort": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"field": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"DEFAULT",
"CREATED_AT"
],
"properties": null,
"inner_properties": null,
"description": "Specifies customer attributes as the sort key to customer profiles returned from a search."
},
"order": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"DESC",
"ASC"
],
"properties": null,
"inner_properties": null,
"description": "The order (e.g., chronological or alphabetical) in which results from a request are returned."
}
},
"inner_properties": null,
"description": "Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results."
}
},
"inner_properties": null,
"description": "Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request."
},
"count": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether to return the total count of matching customers in the `count` field of the response.\n\nThe default value is `false`."
}
},
"inner_properties": null,
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
],
"request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Defines the fields that are included in the request body of a request to the\\n`SearchCustomers` endpoint.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"cursor\": {\n \"type\": \"string\",\n \"description\": \"Include the pagination cursor in subsequent calls to this endpoint to retrieve\\nthe next set of results associated with the original query.\\n\\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\"\n },\n \"limit\": {\n \"type\": \"integer\",\n \"description\": \"The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.\\nIf the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.\\n\\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).\",\n \"format\": \"int64\",\n \"minimum\": 1,\n \"maximum\": 100\n },\n \"query\": {\n \"type\": \"object\",\n \"description\": \"Represents filtering and sorting criteria for a [SearchCustomers](api-endpoint:Customers-SearchCustomers) request.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"filter\": {\n \"type\": \"object\",\n \"description\": \"Represents the filtering criteria in a [search query](entity:CustomerQuery) that defines how to filter\\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"creation_source\": {\n \"type\": \"object\",\n \"description\": \"The creation source filter.\\n\\nIf one or more creation sources are set, customer profiles are included in,\\nor excluded from, the result if they match at least one of the filter criteria.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"values\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"OTHER\",\n \"APPOINTMENTS\",\n \"COUPON\",\n \"DELETION_RECOVERY\",\n \"DIRECTORY\",\n \"EGIFTING\",\n \"EMAIL_COLLECTION\",\n \"FEEDBACK\",\n \"IMPORT\",\n \"INVOICES\",\n \"LOYALTY\",\n \"MARKETING\",\n \"MERGE\",\n \"ONLINE_STORE\",\n \"INSTANT_PROFILE\",\n \"TERMINAL\",\n \"THIRD_PARTY\",\n \"THIRD_PARTY_IMPORT\",\n \"UNMERGE_RECOVERY\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"OTHER\",\n \"description\": \"The default creation source. This source is typically used for backward/future\\ncompatibility when the original source of a customer profile is\\nunrecognized. For example, when older clients do not support newer\\nsource types.\"\n },\n {\n \"name\": \"APPOINTMENTS\",\n \"description\": \"The customer profile was created automatically when an appointment\\nwas scheduled.\"\n },\n {\n \"name\": \"COUPON\",\n \"description\": \"The customer profile was created automatically when a coupon was issued\\nusing Square Point of Sale.\"\n },\n {\n \"name\": \"DELETION_RECOVERY\",\n \"description\": \"The customer profile was restored through Square's deletion recovery\\nprocess.\"\n },\n {\n \"name\": \"DIRECTORY\",\n \"description\": \"The customer profile was created manually through Square Seller Dashboard or the \\nPoint of Sale application.\"\n },\n {\n \"name\": \"EGIFTING\",\n \"description\": \"The customer profile was created automatically when a gift card was\\nissued using Square Point of Sale. Customer profiles are created for\\nboth the buyer and the recipient of the gift card.\"\n },\n {\n \"name\": \"EMAIL_COLLECTION\",\n \"description\": \"The customer profile was created through Square Point of Sale when\\nsigning up for marketing emails during checkout.\"\n },\n {\n \"name\": \"FEEDBACK\",\n \"description\": \"The customer profile was created automatically when providing feedback\\nthrough a digital receipt.\"\n },\n {\n \"name\": \"IMPORT\",\n \"description\": \"The customer profile was created automatically when importing customer\\ndata through Square Seller Dashboard.\"\n },\n {\n \"name\": \"INVOICES\",\n \"description\": \"The customer profile was created automatically during an invoice payment.\"\n },\n {\n \"name\": \"LOYALTY\",\n \"description\": \"The customer profile was created automatically when customers provide a\\nphone number for loyalty reward programs during checkout.\"\n },\n {\n \"name\": \"MARKETING\",\n \"description\": \"The customer profile was created as the result of a campaign managed\\nthrough Square\\u2019s Facebook integration.\"\n },\n {\n \"name\": \"MERGE\",\n \"description\": \"The customer profile was created as the result of explicitly merging\\nmultiple customer profiles through the Square Seller Dashboard or the Point of\\nSale application.\"\n },\n {\n \"name\": \"ONLINE_STORE\",\n \"description\": \"The customer profile was created through Square's Online Store solution\\n(legacy service).\"\n },\n {\n \"name\": \"INSTANT_PROFILE\",\n \"description\": \"The customer profile was created automatically as the result of a successful\\ntransaction that did not explicitly link to an existing customer profile.\"\n },\n {\n \"name\": \"TERMINAL\",\n \"description\": \"The customer profile was created through Square's Virtual Terminal.\"\n },\n {\n \"name\": \"THIRD_PARTY\",\n \"description\": \"The customer profile was created through a Square API call.\"\n },\n {\n \"name\": \"THIRD_PARTY_IMPORT\",\n \"description\": \"The customer profile was created by a third-party product and imported\\nthrough an official integration.\"\n },\n {\n \"name\": \"UNMERGE_RECOVERY\",\n \"description\": \"The customer profile was restored through Square's unmerge recovery\\nprocess.\"\n }\n ],\n \"description\": \"Indicates the method used to create the customer profile.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"description\": \"The list of creation sources used as filtering criteria.\\nSee [CustomerCreationSource](#type-customercreationsource) for possible values\",\n \"nullable\": true\n },\n \"rule\": {\n \"type\": \"string\",\n \"enum\": [\n \"INCLUDE\",\n \"EXCLUDE\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"INCLUDE\",\n \"description\": \"Customers should be included in the result set when they match the\\nfiltering criteria.\"\n },\n {\n \"name\": \"EXCLUDE\",\n \"description\": \"Customers should be excluded from the result set when they match\\nthe filtering criteria.\"\n }\n ],\n \"description\": \"Indicates whether customers should be included in, or excluded from,\\nthe result set when they match the filtering criteria.\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n },\n \"created_at\": {\n \"type\": \"object\",\n \"description\": \"Represents a generic time range. The start and end values are\\nrepresented in RFC 3339 format. Time ranges are customized to be\\ninclusive or exclusive based on the needs of a particular endpoint.\\nRefer to the relevant endpoint-specific documentation to determine\\nhow time ranges are handled.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"start_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nstarts.\",\n \"nullable\": true\n },\n \"end_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nends.\",\n \"nullable\": true\n }\n }\n },\n \"updated_at\": {\n \"type\": \"object\",\n \"description\": \"Represents a generic time range. The start and end values are\\nrepresented in RFC 3339 format. Time ranges are customized to be\\ninclusive or exclusive based on the needs of a particular endpoint.\\nRefer to the relevant endpoint-specific documentation to determine\\nhow time ranges are handled.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"start_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nstarts.\",\n \"nullable\": true\n },\n \"end_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nends.\",\n \"nullable\": true\n }\n }\n },\n \"email_address\": {\n \"type\": \"object\",\n \"description\": \"A filter to select customers based on exact or fuzzy matching of\\ncustomer attributes against a specified query. Depending on the customer attributes, \\nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"exact\": {\n \"type\": \"string\",\n \"description\": \"Use the exact filter to select customers whose attributes match exactly the specified query.\",\n \"nullable\": true\n },\n \"fuzzy\": {\n \"type\": \"string\",\n \"description\": \"Use the fuzzy filter to select customers whose attributes match the specified query \\nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \\neach query token must be matched somewhere in the searched attribute. For single token queries, \\nthis is effectively the same behavior as a partial match operation.\",\n \"nullable\": true\n }\n }\n },\n \"phone_number\": {\n \"type\": \"object\",\n \"description\": \"A filter to select customers based on exact or fuzzy matching of\\ncustomer attributes against a specified query. Depending on the customer attributes, \\nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"exact\": {\n \"type\": \"string\",\n \"description\": \"Use the exact filter to select customers whose attributes match exactly the specified query.\",\n \"nullable\": true\n },\n \"fuzzy\": {\n \"type\": \"string\",\n \"description\": \"Use the fuzzy filter to select customers whose attributes match the specified query \\nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \\neach query token must be matched somewhere in the searched attribute. For single token queries, \\nthis is effectively the same behavior as a partial match operation.\",\n \"nullable\": true\n }\n }\n },\n \"reference_id\": {\n \"type\": \"object\",\n \"description\": \"A filter to select customers based on exact or fuzzy matching of\\ncustomer attributes against a specified query. Depending on the customer attributes, \\nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"exact\": {\n \"type\": \"string\",\n \"description\": \"Use the exact filter to select customers whose attributes match exactly the specified query.\",\n \"nullable\": true\n },\n \"fuzzy\": {\n \"type\": \"string\",\n \"description\": \"Use the fuzzy filter to select customers whose attributes match the specified query \\nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \\neach query token must be matched somewhere in the searched attribute. For single token queries, \\nthis is effectively the same behavior as a partial match operation.\",\n \"nullable\": true\n }\n }\n },\n \"group_ids\": {\n \"type\": \"object\",\n \"description\": \"A filter to select resources based on an exact field value. For any given\\nvalue, the value can only be in one property. Depending on the field, either\\nall properties can be set or only a subset will be available.\\n\\nRefer to the documentation of the field.\",\n \"x-release-status\": \"BETA\",\n \"properties\": {\n \"all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms that must be present on the field of the resource.\",\n \"nullable\": true\n },\n \"any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms where at least one of them must be present on the\\nfield of the resource.\",\n \"nullable\": true\n },\n \"none\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms that must not be present on the field the resource\",\n \"nullable\": true\n }\n }\n },\n \"custom_attribute\": {\n \"type\": \"object\",\n \"description\": \"The custom attribute filters in a set of [customer filters](entity:CustomerFilter) used in a search query. Use this filter\\nto search based on [custom attributes](entity:CustomAttribute) that are assigned to customer profiles. For more information, see\\n[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"filters\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"The custom attribute filter. Use this filter in a set of [custom attribute filters](entity:CustomerCustomAttributeFilters) to search\\nbased on the value or last updated date of a customer-related [custom attribute](entity:CustomAttribute).\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"key\"\n ],\n \"properties\": {\n \"key\": {\n \"type\": \"string\",\n \"description\": \"The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute\\n(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes).\"\n },\n \"filter\": {\n \"type\": \"object\",\n \"description\": \"A type-specific filter used in a [custom attribute filter](entity:CustomerCustomAttributeFilter) to search based on the value \\nof a customer-related [custom attribute](entity:CustomAttribute).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"email\": {\n \"type\": \"object\",\n \"description\": \"A filter to select customers based on exact or fuzzy matching of\\ncustomer attributes against a specified query. Depending on the customer attributes, \\nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"exact\": {\n \"type\": \"string\",\n \"description\": \"Use the exact filter to select customers whose attributes match exactly the specified query.\",\n \"nullable\": true\n },\n \"fuzzy\": {\n \"type\": \"string\",\n \"description\": \"Use the fuzzy filter to select customers whose attributes match the specified query \\nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \\neach query token must be matched somewhere in the searched attribute. For single token queries, \\nthis is effectively the same behavior as a partial match operation.\",\n \"nullable\": true\n }\n }\n },\n \"phone\": {\n \"type\": \"object\",\n \"description\": \"A filter to select customers based on exact or fuzzy matching of\\ncustomer attributes against a specified query. Depending on the customer attributes, \\nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"exact\": {\n \"type\": \"string\",\n \"description\": \"Use the exact filter to select customers whose attributes match exactly the specified query.\",\n \"nullable\": true\n },\n \"fuzzy\": {\n \"type\": \"string\",\n \"description\": \"Use the fuzzy filter to select customers whose attributes match the specified query \\nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \\neach query token must be matched somewhere in the searched attribute. For single token queries, \\nthis is effectively the same behavior as a partial match operation.\",\n \"nullable\": true\n }\n }\n },\n \"text\": {\n \"type\": \"object\",\n \"description\": \"A filter to select customers based on exact or fuzzy matching of\\ncustomer attributes against a specified query. Depending on the customer attributes, \\nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"exact\": {\n \"type\": \"string\",\n \"description\": \"Use the exact filter to select customers whose attributes match exactly the specified query.\",\n \"nullable\": true\n },\n \"fuzzy\": {\n \"type\": \"string\",\n \"description\": \"Use the fuzzy filter to select customers whose attributes match the specified query \\nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \\neach query token must be matched somewhere in the searched attribute. For single token queries, \\nthis is effectively the same behavior as a partial match operation.\",\n \"nullable\": true\n }\n }\n },\n \"selection\": {\n \"type\": \"object\",\n \"description\": \"A filter to select resources based on an exact field value. For any given\\nvalue, the value can only be in one property. Depending on the field, either\\nall properties can be set or only a subset will be available.\\n\\nRefer to the documentation of the field.\",\n \"x-release-status\": \"BETA\",\n \"properties\": {\n \"all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms that must be present on the field of the resource.\",\n \"nullable\": true\n },\n \"any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms where at least one of them must be present on the\\nfield of the resource.\",\n \"nullable\": true\n },\n \"none\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms that must not be present on the field the resource\",\n \"nullable\": true\n }\n }\n },\n \"date\": {\n \"type\": \"object\",\n \"description\": \"Represents a generic time range. The start and end values are\\nrepresented in RFC 3339 format. Time ranges are customized to be\\ninclusive or exclusive based on the needs of a particular endpoint.\\nRefer to the relevant endpoint-specific documentation to determine\\nhow time ranges are handled.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"start_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nstarts.\",\n \"nullable\": true\n },\n \"end_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nends.\",\n \"nullable\": true\n }\n }\n },\n \"number\": {\n \"type\": \"object\",\n \"description\": \"Specifies a decimal number range.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"start_at\": {\n \"type\": \"string\",\n \"description\": \"A decimal value indicating where the range starts.\",\n \"nullable\": true\n },\n \"end_at\": {\n \"type\": \"string\",\n \"description\": \"A decimal value indicating where the range ends.\",\n \"nullable\": true\n }\n }\n },\n \"boolean\": {\n \"type\": \"boolean\",\n \"description\": \"A filter for a query based on the value of a `Boolean`-type custom attribute.\",\n \"nullable\": true\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when\\nsearching by an `Address`-type custom attribute.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"postal_code\": {\n \"type\": \"object\",\n \"description\": \"A filter to select customers based on exact or fuzzy matching of\\ncustomer attributes against a specified query. Depending on the customer attributes, \\nthe filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"exact\": {\n \"type\": \"string\",\n \"description\": \"Use the exact filter to select customers whose attributes match exactly the specified query.\",\n \"nullable\": true\n },\n \"fuzzy\": {\n \"type\": \"string\",\n \"description\": \"Use the fuzzy filter to select customers whose attributes match the specified query \\nin a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then \\neach query token must be matched somewhere in the searched attribute. For single token queries, \\nthis is effectively the same behavior as a partial match operation.\",\n \"nullable\": true\n }\n }\n },\n \"country\": {\n \"type\": \"string\",\n \"enum\": [\n \"ZZ\",\n \"AD\",\n \"AE\",\n \"AF\",\n \"AG\",\n \"AI\",\n \"AL\",\n \"AM\",\n \"AO\",\n \"AQ\",\n \"AR\",\n \"AS\",\n \"AT\",\n \"AU\",\n \"AW\",\n \"AX\",\n \"AZ\",\n \"BA\",\n \"BB\",\n \"BD\",\n \"BE\",\n \"BF\",\n \"BG\",\n \"BH\",\n \"BI\",\n \"BJ\",\n \"BL\",\n \"BM\",\n \"BN\",\n \"BO\",\n \"BQ\",\n \"BR\",\n \"BS\",\n \"BT\",\n \"BV\",\n \"BW\",\n \"BY\",\n \"BZ\",\n \"CA\",\n \"CC\",\n \"CD\",\n \"CF\",\n \"CG\",\n \"CH\",\n \"CI\",\n \"CK\",\n \"CL\",\n \"CM\",\n \"CN\",\n \"CO\",\n \"CR\",\n \"CU\",\n \"CV\",\n \"CW\",\n \"CX\",\n \"CY\",\n \"CZ\",\n \"DE\",\n \"DJ\",\n \"DK\",\n \"DM\",\n \"DO\",\n \"DZ\",\n \"EC\",\n \"EE\",\n \"EG\",\n \"EH\",\n \"ER\",\n \"ES\",\n \"ET\",\n \"FI\",\n \"FJ\",\n \"FK\",\n \"FM\",\n \"FO\",\n \"FR\",\n \"GA\",\n \"GB\",\n \"GD\",\n \"GE\",\n \"GF\",\n \"GG\",\n \"GH\",\n \"GI\",\n \"GL\",\n \"GM\",\n \"GN\",\n \"GP\",\n \"GQ\",\n \"GR\",\n \"GS\",\n \"GT\",\n \"GU\",\n \"GW\",\n \"GY\",\n \"HK\",\n \"HM\",\n \"HN\",\n \"HR\",\n \"HT\",\n \"HU\",\n \"ID\",\n \"IE\",\n \"IL\",\n \"IM\",\n \"IN\",\n \"IO\",\n \"IQ\",\n \"IR\",\n \"IS\",\n \"IT\",\n \"JE\",\n \"JM\",\n \"JO\",\n \"JP\",\n \"KE\",\n \"KG\",\n \"KH\",\n \"KI\",\n \"KM\",\n \"KN\",\n \"KP\",\n \"KR\",\n \"KW\",\n \"KY\",\n \"KZ\",\n \"LA\",\n \"LB\",\n \"LC\",\n \"LI\",\n \"LK\",\n \"LR\",\n \"LS\",\n \"LT\",\n \"LU\",\n \"LV\",\n \"LY\",\n \"MA\",\n \"MC\",\n \"MD\",\n \"ME\",\n \"MF\",\n \"MG\",\n \"MH\",\n \"MK\",\n \"ML\",\n \"MM\",\n \"MN\",\n \"MO\",\n \"MP\",\n \"MQ\",\n \"MR\",\n \"MS\",\n \"MT\",\n \"MU\",\n \"MV\",\n \"MW\",\n \"MX\",\n \"MY\",\n \"MZ\",\n \"NA\",\n \"NC\",\n \"NE\",\n \"NF\",\n \"NG\",\n \"NI\",\n \"NL\",\n \"NO\",\n \"NP\",\n \"NR\",\n \"NU\",\n \"NZ\",\n \"OM\",\n \"PA\",\n \"PE\",\n \"PF\",\n \"PG\",\n \"PH\",\n \"PK\",\n \"PL\",\n \"PM\",\n \"PN\",\n \"PR\",\n \"PS\",\n \"PT\",\n \"PW\",\n \"PY\",\n \"QA\",\n \"RE\",\n \"RO\",\n \"RS\",\n \"RU\",\n \"RW\",\n \"SA\",\n \"SB\",\n \"SC\",\n \"SD\",\n \"SE\",\n \"SG\",\n \"SH\",\n \"SI\",\n \"SJ\",\n \"SK\",\n \"SL\",\n \"SM\",\n \"SN\",\n \"SO\",\n \"SR\",\n \"SS\",\n \"ST\",\n \"SV\",\n \"SX\",\n \"SY\",\n \"SZ\",\n \"TC\",\n \"TD\",\n \"TF\",\n \"TG\",\n \"TH\",\n \"TJ\",\n \"TK\",\n \"TL\",\n \"TM\",\n \"TN\",\n \"TO\",\n \"TR\",\n \"TT\",\n \"TV\",\n \"TW\",\n \"TZ\",\n \"UA\",\n \"UG\",\n \"UM\",\n \"US\",\n \"UY\",\n \"UZ\",\n \"VA\",\n \"VC\",\n \"VE\",\n \"VG\",\n \"VI\",\n \"VN\",\n \"VU\",\n \"WF\",\n \"WS\",\n \"YE\",\n \"YT\",\n \"ZA\",\n \"ZM\",\n \"ZW\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"ZZ\",\n \"description\": \"Unknown\"\n },\n {\n \"name\": \"AD\",\n \"description\": \"Andorra\"\n },\n {\n \"name\": \"AE\",\n \"description\": \"United Arab Emirates\"\n },\n {\n \"name\": \"AF\",\n \"description\": \"Afghanistan\"\n },\n {\n \"name\": \"AG\",\n \"description\": \"Antigua and Barbuda\"\n },\n {\n \"name\": \"AI\",\n \"description\": \"Anguilla\"\n },\n {\n \"name\": \"AL\",\n \"description\": \"Albania\"\n },\n {\n \"name\": \"AM\",\n \"description\": \"Armenia\"\n },\n {\n \"name\": \"AO\",\n \"description\": \"Angola\"\n },\n {\n \"name\": \"AQ\",\n \"description\": \"Antartica\"\n },\n {\n \"name\": \"AR\",\n \"description\": \"Argentina\"\n },\n {\n \"name\": \"AS\",\n \"description\": \"American Samoa\"\n },\n {\n \"name\": \"AT\",\n \"description\": \"Austria\"\n },\n {\n \"name\": \"AU\",\n \"description\": \"Australia\"\n },\n {\n \"name\": \"AW\",\n \"description\": \"Aruba\"\n },\n {\n \"name\": \"AX\",\n \"description\": \"\\u00c5land Islands\"\n },\n {\n \"name\": \"AZ\",\n \"description\": \"Azerbaijan\"\n },\n {\n \"name\": \"BA\",\n \"description\": \"Bosnia and Herzegovina\"\n },\n {\n \"name\": \"BB\",\n \"description\": \"Barbados\"\n },\n {\n \"name\": \"BD\",\n \"description\": \"Bangladesh\"\n },\n {\n \"name\": \"BE\",\n \"description\": \"Belgium\"\n },\n {\n \"name\": \"BF\",\n \"description\": \"Burkina Faso\"\n },\n {\n \"name\": \"BG\",\n \"description\": \"Bulgaria\"\n },\n {\n \"name\": \"BH\",\n \"description\": \"Bahrain\"\n },\n {\n \"name\": \"BI\",\n \"description\": \"Burundi\"\n },\n {\n \"name\": \"BJ\",\n \"description\": \"Benin\"\n },\n {\n \"name\": \"BL\",\n \"description\": \"Saint Barth\\u00e9lemy\"\n },\n {\n \"name\": \"BM\",\n \"description\": \"Bermuda\"\n },\n {\n \"name\": \"BN\",\n \"description\": \"Brunei\"\n },\n {\n \"name\": \"BO\",\n \"description\": \"Bolivia\"\n },\n {\n \"name\": \"BQ\",\n \"description\": \"Bonaire\"\n },\n {\n \"name\": \"BR\",\n \"description\": \"Brazil\"\n },\n {\n \"name\": \"BS\",\n \"description\": \"Bahamas\"\n },\n {\n \"name\": \"BT\",\n \"description\": \"Bhutan\"\n },\n {\n \"name\": \"BV\",\n \"description\": \"Bouvet Island\"\n },\n {\n \"name\": \"BW\",\n \"description\": \"Botswana\"\n },\n {\n \"name\": \"BY\",\n \"description\": \"Belarus\"\n },\n {\n \"name\": \"BZ\",\n \"description\": \"Belize\"\n },\n {\n \"name\": \"CA\",\n \"description\": \"Canada\"\n },\n {\n \"name\": \"CC\",\n \"description\": \"Cocos Islands\"\n },\n {\n \"name\": \"CD\",\n \"description\": \"Democratic Republic of the Congo\"\n },\n {\n \"name\": \"CF\",\n \"description\": \"Central African Republic\"\n },\n {\n \"name\": \"CG\",\n \"description\": \"Congo\"\n },\n {\n \"name\": \"CH\",\n \"description\": \"Switzerland\"\n },\n {\n \"name\": \"CI\",\n \"description\": \"Ivory Coast\"\n },\n {\n \"name\": \"CK\",\n \"description\": \"Cook Islands\"\n },\n {\n \"name\": \"CL\",\n \"description\": \"Chile\"\n },\n {\n \"name\": \"CM\",\n \"description\": \"Cameroon\"\n },\n {\n \"name\": \"CN\",\n \"description\": \"China\"\n },\n {\n \"name\": \"CO\",\n \"description\": \"Colombia\"\n },\n {\n \"name\": \"CR\",\n \"description\": \"Costa Rica\"\n },\n {\n \"name\": \"CU\",\n \"description\": \"Cuba\"\n },\n {\n \"name\": \"CV\",\n \"description\": \"Cabo Verde\"\n },\n {\n \"name\": \"CW\",\n \"description\": \"Cura\\u00e7ao\"\n },\n {\n \"name\": \"CX\",\n \"description\": \"Christmas Island\"\n },\n {\n \"name\": \"CY\",\n \"description\": \"Cyprus\"\n },\n {\n \"name\": \"CZ\",\n \"description\": \"Czechia\"\n },\n {\n \"name\": \"DE\",\n \"description\": \"Germany\"\n },\n {\n \"name\": \"DJ\",\n \"description\": \"Djibouti\"\n },\n {\n \"name\": \"DK\",\n \"description\": \"Denmark\"\n },\n {\n \"name\": \"DM\",\n \"description\": \"Dominica\"\n },\n {\n \"name\": \"DO\",\n \"description\": \"Dominican Republic\"\n },\n {\n \"name\": \"DZ\",\n \"description\": \"Algeria\"\n },\n {\n \"name\": \"EC\",\n \"description\": \"Ecuador\"\n },\n {\n \"name\": \"EE\",\n \"description\": \"Estonia\"\n },\n {\n \"name\": \"EG\",\n \"description\": \"Egypt\"\n },\n {\n \"name\": \"EH\",\n \"description\": \"Western Sahara\"\n },\n {\n \"name\": \"ER\",\n \"description\": \"Eritrea\"\n },\n {\n \"name\": \"ES\",\n \"description\": \"Spain\"\n },\n {\n \"name\": \"ET\",\n \"description\": \"Ethiopia\"\n },\n {\n \"name\": \"FI\",\n \"description\": \"Finland\"\n },\n {\n \"name\": \"FJ\",\n \"description\": \"Fiji\"\n },\n {\n \"name\": \"FK\",\n \"description\": \"Falkland Islands\"\n },\n {\n \"name\": \"FM\",\n \"description\": \"Federated States of Micronesia\"\n },\n {\n \"name\": \"FO\",\n \"description\": \"Faroe Islands\"\n },\n {\n \"name\": \"FR\",\n \"description\": \"France\"\n },\n {\n \"name\": \"GA\",\n \"description\": \"Gabon\"\n },\n {\n \"name\": \"GB\",\n \"description\": \"United Kingdom\"\n },\n {\n \"name\": \"GD\",\n \"description\": \"Grenada\"\n },\n {\n \"name\": \"GE\",\n \"description\": \"Georgia\"\n },\n {\n \"name\": \"GF\",\n \"description\": \"French Guiana\"\n },\n {\n \"name\": \"GG\",\n \"description\": \"Guernsey\"\n },\n {\n \"name\": \"GH\",\n \"description\": \"Ghana\"\n },\n {\n \"name\": \"GI\",\n \"description\": \"Gibraltar\"\n },\n {\n \"name\": \"GL\",\n \"description\": \"Greenland\"\n },\n {\n \"name\": \"GM\",\n \"description\": \"Gambia\"\n },\n {\n \"name\": \"GN\",\n \"description\": \"Guinea\"\n },\n {\n \"name\": \"GP\",\n \"description\": \"Guadeloupe\"\n },\n {\n \"name\": \"GQ\",\n \"description\": \"Equatorial Guinea\"\n },\n {\n \"name\": \"GR\",\n \"description\": \"Greece\"\n },\n {\n \"name\": \"GS\",\n \"description\": \"South Georgia and the South Sandwich Islands\"\n },\n {\n \"name\": \"GT\",\n \"description\": \"Guatemala\"\n },\n {\n \"name\": \"GU\",\n \"description\": \"Guam\"\n },\n {\n \"name\": \"GW\",\n \"description\": \"Guinea-Bissau\"\n },\n {\n \"name\": \"GY\",\n \"description\": \"Guyana\"\n },\n {\n \"name\": \"HK\",\n \"description\": \"Hong Kong\"\n },\n {\n \"name\": \"HM\",\n \"description\": \"Heard Island and McDonald Islands\"\n },\n {\n \"name\": \"HN\",\n \"description\": \"Honduras\"\n },\n {\n \"name\": \"HR\",\n \"description\": \"Croatia\"\n },\n {\n \"name\": \"HT\",\n \"description\": \"Haiti\"\n },\n {\n \"name\": \"HU\",\n \"description\": \"Hungary\"\n },\n {\n \"name\": \"ID\",\n \"description\": \"Indonesia\"\n },\n {\n \"name\": \"IE\",\n \"description\": \"Ireland\"\n },\n {\n \"name\": \"IL\",\n \"description\": \"Israel\"\n },\n {\n \"name\": \"IM\",\n \"description\": \"Isle of Man\"\n },\n {\n \"name\": \"IN\",\n \"description\": \"India\"\n },\n {\n \"name\": \"IO\",\n \"description\": \"British Indian Ocean Territory\"\n },\n {\n \"name\": \"IQ\",\n \"description\": \"Iraq\"\n },\n {\n \"name\": \"IR\",\n \"description\": \"Iran\"\n },\n {\n \"name\": \"IS\",\n \"description\": \"Iceland\"\n },\n {\n \"name\": \"IT\",\n \"description\": \"Italy\"\n },\n {\n \"name\": \"JE\",\n \"description\": \"Jersey\"\n },\n {\n \"name\": \"JM\",\n \"description\": \"Jamaica\"\n },\n {\n \"name\": \"JO\",\n \"description\": \"Jordan\"\n },\n {\n \"name\": \"JP\",\n \"description\": \"Japan\"\n },\n {\n \"name\": \"KE\",\n \"description\": \"Kenya\"\n },\n {\n \"name\": \"KG\",\n \"description\": \"Kyrgyzstan\"\n },\n {\n \"name\": \"KH\",\n \"description\": \"Cambodia\"\n },\n {\n \"name\": \"KI\",\n \"description\": \"Kiribati\"\n },\n {\n \"name\": \"KM\",\n \"description\": \"Comoros\"\n },\n {\n \"name\": \"KN\",\n \"description\": \"Saint Kitts and Nevis\"\n },\n {\n \"name\": \"KP\",\n \"description\": \"Democratic People's Republic of Korea\"\n },\n {\n \"name\": \"KR\",\n \"description\": \"Republic of Korea\"\n },\n {\n \"name\": \"KW\",\n \"description\": \"Kuwait\"\n },\n {\n \"name\": \"KY\",\n \"description\": \"Cayman Islands\"\n },\n {\n \"name\": \"KZ\",\n \"description\": \"Kazakhstan\"\n },\n {\n \"name\": \"LA\",\n \"description\": \"Lao People's Democratic Republic\"\n },\n {\n \"name\": \"LB\",\n \"description\": \"Lebanon\"\n },\n {\n \"name\": \"LC\",\n \"description\": \"Saint Lucia\"\n },\n {\n \"name\": \"LI\",\n \"description\": \"Liechtenstein\"\n },\n {\n \"name\": \"LK\",\n \"description\": \"Sri Lanka\"\n },\n {\n \"name\": \"LR\",\n \"description\": \"Liberia\"\n },\n {\n \"name\": \"LS\",\n \"description\": \"Lesotho\"\n },\n {\n \"name\": \"LT\",\n \"description\": \"Lithuania\"\n },\n {\n \"name\": \"LU\",\n \"description\": \"Luxembourg\"\n },\n {\n \"name\": \"LV\",\n \"description\": \"Latvia\"\n },\n {\n \"name\": \"LY\",\n \"description\": \"Libya\"\n },\n {\n \"name\": \"MA\",\n \"description\": \"Morocco\"\n },\n {\n \"name\": \"MC\",\n \"description\": \"Monaco\"\n },\n {\n \"name\": \"MD\",\n \"description\": \"Moldova\"\n },\n {\n \"name\": \"ME\",\n \"description\": \"Montenegro\"\n },\n {\n \"name\": \"MF\",\n \"description\": \"Saint Martin\"\n },\n {\n \"name\": \"MG\",\n \"description\": \"Madagascar\"\n },\n {\n \"name\": \"MH\",\n \"description\": \"Marshall Islands\"\n },\n {\n \"name\": \"MK\",\n \"description\": \"North Macedonia\"\n },\n {\n \"name\": \"ML\",\n \"description\": \"Mali\"\n },\n {\n \"name\": \"MM\",\n \"description\": \"Myanmar\"\n },\n {\n \"name\": \"MN\",\n \"description\": \"Mongolia\"\n },\n {\n \"name\": \"MO\",\n \"description\": \"Macao\"\n },\n {\n \"name\": \"MP\",\n \"description\": \"Northern Mariana Islands\"\n },\n {\n \"name\": \"MQ\",\n \"description\": \"Martinique\"\n },\n {\n \"name\": \"MR\",\n \"description\": \"Mauritania\"\n },\n {\n \"name\": \"MS\",\n \"description\": \"Montserrat\"\n },\n {\n \"name\": \"MT\",\n \"description\": \"Malta\"\n },\n {\n \"name\": \"MU\",\n \"description\": \"Mauritius\"\n },\n {\n \"name\": \"MV\",\n \"description\": \"Maldives\"\n },\n {\n \"name\": \"MW\",\n \"description\": \"Malawi\"\n },\n {\n \"name\": \"MX\",\n \"description\": \"Mexico\"\n },\n {\n \"name\": \"MY\",\n \"description\": \"Malaysia\"\n },\n {\n \"name\": \"MZ\",\n \"description\": \"Mozambique\"\n },\n {\n \"name\": \"NA\",\n \"description\": \"Namibia\"\n },\n {\n \"name\": \"NC\",\n \"description\": \"New Caledonia\"\n },\n {\n \"name\": \"NE\",\n \"description\": \"Niger\"\n },\n {\n \"name\": \"NF\",\n \"description\": \"Norfolk Island\"\n },\n {\n \"name\": \"NG\",\n \"description\": \"Nigeria\"\n },\n {\n \"name\": \"NI\",\n \"description\": \"Nicaragua\"\n },\n {\n \"name\": \"NL\",\n \"description\": \"Netherlands\"\n },\n {\n \"name\": \"NO\",\n \"description\": \"Norway\"\n },\n {\n \"name\": \"NP\",\n \"description\": \"Nepal\"\n },\n {\n \"name\": \"NR\",\n \"description\": \"Nauru\"\n },\n {\n \"name\": \"NU\",\n \"description\": \"Niue\"\n },\n {\n \"name\": \"NZ\",\n \"description\": \"New Zealand\"\n },\n {\n \"name\": \"OM\",\n \"description\": \"Oman\"\n },\n {\n \"name\": \"PA\",\n \"description\": \"Panama\"\n },\n {\n \"name\": \"PE\",\n \"description\": \"Peru\"\n },\n {\n \"name\": \"PF\",\n \"description\": \"French Polynesia\"\n },\n {\n \"name\": \"PG\",\n \"description\": \"Papua New Guinea\"\n },\n {\n \"name\": \"PH\",\n \"description\": \"Philippines\"\n },\n {\n \"name\": \"PK\",\n \"description\": \"Pakistan\"\n },\n {\n \"name\": \"PL\",\n \"description\": \"Poland\"\n },\n {\n \"name\": \"PM\",\n \"description\": \"Saint Pierre and Miquelon\"\n },\n {\n \"name\": \"PN\",\n \"description\": \"Pitcairn\"\n },\n {\n \"name\": \"PR\",\n \"description\": \"Puerto Rico\"\n },\n {\n \"name\": \"PS\",\n \"description\": \"Palestine\"\n },\n {\n \"name\": \"PT\",\n \"description\": \"Portugal\"\n },\n {\n \"name\": \"PW\",\n \"description\": \"Palau\"\n },\n {\n \"name\": \"PY\",\n \"description\": \"Paraguay\"\n },\n {\n \"name\": \"QA\",\n \"description\": \"Qatar\"\n },\n {\n \"name\": \"RE\",\n \"description\": \"R\\u00e9union\"\n },\n {\n \"name\": \"RO\",\n \"description\": \"Romania\"\n },\n {\n \"name\": \"RS\",\n \"description\": \"Serbia\"\n },\n {\n \"name\": \"RU\",\n \"description\": \"Russia\"\n },\n {\n \"name\": \"RW\",\n \"description\": \"Rwanda\"\n },\n {\n \"name\": \"SA\",\n \"description\": \"Saudi Arabia\"\n },\n {\n \"name\": \"SB\",\n \"description\": \"Solomon Islands\"\n },\n {\n \"name\": \"SC\",\n \"description\": \"Seychelles\"\n },\n {\n \"name\": \"SD\",\n \"description\": \"Sudan\"\n },\n {\n \"name\": \"SE\",\n \"description\": \"Sweden\"\n },\n {\n \"name\": \"SG\",\n \"description\": \"Singapore\"\n },\n {\n \"name\": \"SH\",\n \"description\": \"Saint Helena, Ascension and Tristan da Cunha\"\n },\n {\n \"name\": \"SI\",\n \"description\": \"Slovenia\"\n },\n {\n \"name\": \"SJ\",\n \"description\": \"Svalbard and Jan Mayen\"\n },\n {\n \"name\": \"SK\",\n \"description\": \"Slovakia\"\n },\n {\n \"name\": \"SL\",\n \"description\": \"Sierra Leone\"\n },\n {\n \"name\": \"SM\",\n \"description\": \"San Marino\"\n },\n {\n \"name\": \"SN\",\n \"description\": \"Senegal\"\n },\n {\n \"name\": \"SO\",\n \"description\": \"Somalia\"\n },\n {\n \"name\": \"SR\",\n \"description\": \"Suriname\"\n },\n {\n \"name\": \"SS\",\n \"description\": \"South Sudan\"\n },\n {\n \"name\": \"ST\",\n \"description\": \"Sao Tome and Principe\"\n },\n {\n \"name\": \"SV\",\n \"description\": \"El Salvador\"\n },\n {\n \"name\": \"SX\",\n \"description\": \"Sint Maarten\"\n },\n {\n \"name\": \"SY\",\n \"description\": \"Syrian Arab Republic\"\n },\n {\n \"name\": \"SZ\",\n \"description\": \"Eswatini\"\n },\n {\n \"name\": \"TC\",\n \"description\": \"Turks and Caicos Islands\"\n },\n {\n \"name\": \"TD\",\n \"description\": \"Chad\"\n },\n {\n \"name\": \"TF\",\n \"description\": \"French Southern Territories\"\n },\n {\n \"name\": \"TG\",\n \"description\": \"Togo\"\n },\n {\n \"name\": \"TH\",\n \"description\": \"Thailand\"\n },\n {\n \"name\": \"TJ\",\n \"description\": \"Tajikistan\"\n },\n {\n \"name\": \"TK\",\n \"description\": \"Tokelau\"\n },\n {\n \"name\": \"TL\",\n \"description\": \"Timor-Leste\"\n },\n {\n \"name\": \"TM\",\n \"description\": \"Turkmenistan\"\n },\n {\n \"name\": \"TN\",\n \"description\": \"Tunisia\"\n },\n {\n \"name\": \"TO\",\n \"description\": \"Tonga\"\n },\n {\n \"name\": \"TR\",\n \"description\": \"Turkey\"\n },\n {\n \"name\": \"TT\",\n \"description\": \"Trinidad and Tobago\"\n },\n {\n \"name\": \"TV\",\n \"description\": \"Tuvalu\"\n },\n {\n \"name\": \"TW\",\n \"description\": \"Taiwan\"\n },\n {\n \"name\": \"TZ\",\n \"description\": \"Tanzania\"\n },\n {\n \"name\": \"UA\",\n \"description\": \"Ukraine\"\n },\n {\n \"name\": \"UG\",\n \"description\": \"Uganda\"\n },\n {\n \"name\": \"UM\",\n \"description\": \"United States Minor Outlying Islands\"\n },\n {\n \"name\": \"US\",\n \"description\": \"United States of America\"\n },\n {\n \"name\": \"UY\",\n \"description\": \"Uruguay\"\n },\n {\n \"name\": \"UZ\",\n \"description\": \"Uzbekistan\"\n },\n {\n \"name\": \"VA\",\n \"description\": \"Vatican City\"\n },\n {\n \"name\": \"VC\",\n \"description\": \"Saint Vincent and the Grenadines\"\n },\n {\n \"name\": \"VE\",\n \"description\": \"Venezuela\"\n },\n {\n \"name\": \"VG\",\n \"description\": \"British Virgin Islands\"\n },\n {\n \"name\": \"VI\",\n \"description\": \"U.S. Virgin Islands\"\n },\n {\n \"name\": \"VN\",\n \"description\": \"Vietnam\"\n },\n {\n \"name\": \"VU\",\n \"description\": \"Vanuatu\"\n },\n {\n \"name\": \"WF\",\n \"description\": \"Wallis and Futuna\"\n },\n {\n \"name\": \"WS\",\n \"description\": \"Samoa\"\n },\n {\n \"name\": \"YE\",\n \"description\": \"Yemen\"\n },\n {\n \"name\": \"YT\",\n \"description\": \"Mayotte\"\n },\n {\n \"name\": \"ZA\",\n \"description\": \"South Africa\"\n },\n {\n \"name\": \"ZM\",\n \"description\": \"Zambia\"\n },\n {\n \"name\": \"ZW\",\n \"description\": \"Zimbabwe\"\n }\n ],\n \"description\": \"Indicates the country associated with another entity, such as a business.\\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n }\n }\n },\n \"updated_at\": {\n \"type\": \"object\",\n \"description\": \"Represents a generic time range. The start and end values are\\nrepresented in RFC 3339 format. Time ranges are customized to be\\ninclusive or exclusive based on the needs of a particular endpoint.\\nRefer to the relevant endpoint-specific documentation to determine\\nhow time ranges are handled.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"start_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nstarts.\",\n \"nullable\": true\n },\n \"end_at\": {\n \"type\": \"string\",\n \"description\": \"A datetime value in RFC 3339 format indicating when the time range\\nends.\",\n \"nullable\": true\n }\n }\n }\n }\n },\n \"description\": \"The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,\\nthe `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters.\",\n \"nullable\": true\n }\n }\n },\n \"segment_ids\": {\n \"type\": \"object\",\n \"description\": \"A filter to select resources based on an exact field value. For any given\\nvalue, the value can only be in one property. Depending on the field, either\\nall properties can be set or only a subset will be available.\\n\\nRefer to the documentation of the field.\",\n \"x-release-status\": \"BETA\",\n \"properties\": {\n \"all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms that must be present on the field of the resource.\",\n \"nullable\": true\n },\n \"any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms where at least one of them must be present on the\\nfield of the resource.\",\n \"nullable\": true\n },\n \"none\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"A list of terms that must not be present on the field the resource\",\n \"nullable\": true\n }\n }\n }\n }\n },\n \"sort\": {\n \"type\": \"object\",\n \"description\": \"Represents the sorting criteria in a [search query](entity:CustomerQuery) that defines how to sort\\ncustomer profiles returned in [SearchCustomers](api-endpoint:Customers-SearchCustomers) results.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"field\": {\n \"type\": \"string\",\n \"enum\": [\n \"DEFAULT\",\n \"CREATED_AT\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"DEFAULT\",\n \"description\": \"Use the default sort key. By default, customers are sorted\\nalphanumerically by concatenating their `given_name` and `family_name`. If\\nneither name field is set, string comparison is performed using one of the\\nremaining fields in the following order: `company_name`, `email`,\\n`phone_number`.\"\n },\n {\n \"name\": \"CREATED_AT\",\n \"description\": \"Use the creation date attribute (`created_at`) of customer profiles as the sort key.\"\n }\n ],\n \"description\": \"Specifies customer attributes as the sort key to customer profiles returned from a search.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"order\": {\n \"type\": \"string\",\n \"enum\": [\n \"DESC\",\n \"ASC\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"DESC\",\n \"description\": \"The results are returned in descending (e.g., newest-first or Z-A) order.\"\n },\n {\n \"name\": \"ASC\",\n \"description\": \"The results are returned in ascending (e.g., oldest-first or A-Z) order.\"\n }\n ],\n \"description\": \"The order (e.g., chronological or alphabetical) in which results from a request are returned.\",\n \"x-release-status\": \"PUBLIC\"\n }\n }\n }\n }\n },\n \"count\": {\n \"type\": \"boolean\",\n \"description\": \"Indicates whether to return the total count of matching customers in the `count` field of the response.\\n\\nThe default value is `false`.\"\n }\n },\n \"example\": {\n \"limit\": 2,\n \"query\": {\n \"filter\": {\n \"created_at\": {\n \"end_at\": \"2018-02-01T00:00:00-00:00\",\n \"start_at\": \"2018-01-01T00:00:00-00:00\"\n },\n \"creation_source\": {\n \"rule\": \"INCLUDE\",\n \"values\": [\n \"THIRD_PARTY\"\n ]\n },\n \"email_address\": {\n \"fuzzy\": \"example.com\"\n },\n \"group_ids\": {\n \"all\": [\n \"545AXB44B4XXWMVQ4W8SBT3HHF\"\n ]\n }\n },\n \"sort\": {\n \"field\": \"CREATED_AT\",\n \"order\": \"ASC\"\n }\n }\n },\n \"x-sq-sdk-sample-code\": {\n \"csharp\": \"/sdk_samples/SearchCustomers/SearchCustomersRequest.csharp\",\n \"java\": \"/sdk_samples/SearchCustomers/SearchCustomersRequest.java\",\n \"javascript\": \"/sdk_samples/SearchCustomers/SearchCustomersRequest.javascript\",\n \"php\": \"/sdk_samples/SearchCustomers/SearchCustomersRequest.php\",\n \"python\": \"/sdk_samples/SearchCustomers/SearchCustomersRequest.python\",\n \"ruby\": \"/sdk_samples/SearchCustomers/SearchCustomersRequest.ruby\"\n }\n }\n }\n }\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}