Square · Schema
SearchCustomersRequest
Defines the fields that are included in the request body of a request to the `SearchCustomers` endpoint.
BookingLocationSquareRestaurantCatalogCheckoutCustomersDisputesE-CommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLoyaltyMerchantsOrderPaymentsPoint-of-SaleRefundsRetailSubscriptionTeamWebhookPayment ProcessingPayment Terminals
Properties
| Name | Type | Description |
|---|---|---|
| cursor | string | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. For more information, see [Pagination](https://developer.squa |
| limit | integer | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is invalid, Square returns a `400 VALUE_TOO_L |
| query | object | The filtering and sorting criteria for the search request. If a query is not specified, Square returns all customer profiles ordered alphabetically by `given_name` and `family_name`. |
| count | boolean | Indicates whether to return the total count of matching customers in the `count` field of the response. The default value is `false`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/square/main/json-schema/square-search-customers-request-schema.json",
"title": "SearchCustomersRequest",
"description": "Defines the fields that are included in the request body of a request to the\n`SearchCustomers` endpoint.",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/square-customers-api-openapi.yml#/components/schemas/SearchCustomersRequest",
"type": "object",
"x-release-status": "PUBLIC",
"properties": {
"cursor": {
"type": "string",
"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": {
"type": "integer",
"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).",
"format": "int64",
"minimum": 1,
"maximum": 100
},
"query": {
"$ref": "#/$defs/CustomerQuery",
"description": "The filtering and sorting criteria for the search request. If a query is not specified,\nSquare returns all customer profiles ordered alphabetically by `given_name` and `family_name`."
},
"count": {
"type": "boolean",
"description": "Indicates whether to return the total count of matching customers in the `count` field of the response.\n\nThe default value is `false`."
}
},
"x-sq-sdk-sample-code": {
"csharp": "/sdk_samples/SearchCustomers/SearchCustomersRequest.csharp",
"java": "/sdk_samples/SearchCustomers/SearchCustomersRequest.java",
"javascript": "/sdk_samples/SearchCustomers/SearchCustomersRequest.javascript",
"php": "/sdk_samples/SearchCustomers/SearchCustomersRequest.php",
"python": "/sdk_samples/SearchCustomers/SearchCustomersRequest.python",
"ruby": "/sdk_samples/SearchCustomers/SearchCustomersRequest.ruby"
},
"$defs": {
"Country": {
"type": "string",
"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"
],
"x-enum-elements": [
{
"name": "ZZ",
"description": "Unknown"
},
{
"name": "AD",
"description": "Andorra"
},
{
"name": "AE",
"description": "United Arab Emirates"
},
{
"name": "AF",
"description": "Afghanistan"
},
{
"name": "AG",
"description": "Antigua and Barbuda"
},
{
"name": "AI",
"description": "Anguilla"
},
{
"name": "AL",
"description": "Albania"
},
{
"name": "AM",
"description": "Armenia"
},
{
"name": "AO",
"description": "Angola"
},
{
"name": "AQ",
"description": "Antartica"
},
{
"name": "AR",
"description": "Argentina"
},
{
"name": "AS",
"description": "American Samoa"
},
{
"name": "AT",
"description": "Austria"
},
{
"name": "AU",
"description": "Australia"
},
{
"name": "AW",
"description": "Aruba"
},
{
"name": "AX",
"description": "Åland Islands"
},
{
"name": "AZ",
"description": "Azerbaijan"
},
{
"name": "BA",
"description": "Bosnia and Herzegovina"
},
{
"name": "BB",
"description": "Barbados"
},
{
"name": "BD",
"description": "Bangladesh"
},
{
"name": "BE",
"description": "Belgium"
},
{
"name": "BF",
"description": "Burkina Faso"
},
{
"name": "BG",
"description": "Bulgaria"
},
{
"name": "BH",
"description": "Bahrain"
},
{
"name": "BI",
"description": "Burundi"
},
{
"name": "BJ",
"description": "Benin"
},
{
"name": "BL",
"description": "Saint Barthélemy"
},
{
"name": "BM",
"description": "Bermuda"
},
{
"name": "BN",
"description": "Brunei"
},
{
"name": "BO",
"description": "Bolivia"
},
{
"name": "BQ",
"description": "Bonaire"
},
{
"name": "BR",
"description": "Brazil"
},
{
"name": "BS",
"description": "Bahamas"
},
{
"name": "BT",
"description": "Bhutan"
},
{
"name": "BV",
"description": "Bouvet Island"
},
{
"name": "BW",
"description": "Botswana"
},
{
"name": "BY",
"description": "Belarus"
},
{
"name": "BZ",
"description": "Belize"
},
{
"name": "CA",
"description": "Canada"
},
{
"name": "CC",
"description": "Cocos Islands"
},
{
"name": "CD",
"description": "Democratic Republic of the Congo"
},
{
"name": "CF",
"description": "Central African Republic"
},
{
"name": "CG",
"description": "Congo"
},
{
"name": "CH",
"description": "Switzerland"
},
{
"name": "CI",
"description": "Ivory Coast"
},
{
"name": "CK",
"description": "Cook Islands"
},
{
"name": "CL",
"description": "Chile"
},
{
"name": "CM",
"description": "Cameroon"
},
{
"name": "CN",
"description": "China"
},
{
"name": "CO",
"description": "Colombia"
},
{
"name": "CR",
"description": "Costa Rica"
},
{
"name": "CU",
"description": "Cuba"
},
{
"name": "CV",
"description": "Cabo Verde"
},
{
"name": "CW",
"description": "Curaçao"
},
{
"name": "CX",
"description": "Christmas Island"
},
{
"name": "CY",
"description": "Cyprus"
},
{
"name": "CZ",
"description": "Czechia"
},
{
"name": "DE",
"description": "Germany"
},
{
"name": "DJ",
"description": "Djibouti"
},
{
"name": "DK",
"description": "Denmark"
},
{
"name": "DM",
"description": "Dominica"
},
{
"name": "DO",
"description": "Dominican Republic"
},
{
"name": "DZ",
"description": "Algeria"
},
{
"name": "EC",
"description": "Ecuador"
},
{
"name": "EE",
"description": "Estonia"
},
{
"name": "EG",
"description": "Egypt"
},
{
"name": "EH",
"description": "Western Sahara"
},
{
"name": "ER",
"description": "Eritrea"
},
{
"name": "ES",
"description": "Spain"
},
{
"name": "ET",
"description": "Ethiopia"
},
{
"name": "FI",
"description": "Finland"
},
{
"name": "FJ",
"description": "Fiji"
},
{
"name": "FK",
"description": "Falkland Islands"
},
{
"name": "FM",
"description": "Federated States of Micronesia"
},
{
"name": "FO",
"description": "Faroe Islands"
},
{
"name": "FR",
"description": "France"
},
{
"name": "GA",
"description": "Gabon"
},
{
"name": "GB",
"description": "United Kingdom"
},
{
"name": "GD",
"description": "Grenada"
},
{
"name": "GE",
"description": "Georgia"
},
{
"name": "GF",
"description": "French Guiana"
},
{
"name": "GG",
"description": "Guernsey"
},
{
"name": "GH",
"description": "Ghana"
},
{
"name": "GI",
"description": "Gibraltar"
},
{
"name": "GL",
"description": "Greenland"
},
{
"name": "GM",
"description": "Gambia"
},
{
"name": "GN",
"description": "Guinea"
},
{
"name": "GP",
"description": "Guadeloupe"
},
{
"name": "GQ",
"description": "Equatorial Guinea"
},
{
"name": "GR",
"description": "Greece"
},
{
"name": "GS",
"description": "South Georgia and the South Sandwich Islands"
},
{
"name": "GT",
"description": "Guatemala"
},
{
"name": "GU",
"description": "Guam"
},
{
"name": "GW",
"description": "Guinea-Bissau"
},
{
"name": "GY",
"description": "Guyana"
},
{
"name": "HK",
"description": "Hong Kong"
},
{
"name": "HM",
"description": "Heard Island and McDonald Islands"
},
{
"name": "HN",
"description": "Honduras"
},
{
"name": "HR",
"description": "Croatia"
},
{
"name": "HT",
"description": "Haiti"
},
{
"name": "HU",
"description": "Hungary"
},
{
"name": "ID",
"description": "Indonesia"
},
{
"name": "IE",
"description": "Ireland"
},
{
"name": "IL",
"description": "Israel"
},
{
"name": "IM",
"description": "Isle of Man"
},
{
"name": "IN",
"description": "India"
},
{
"name": "IO",
"description": "British Indian Ocean Territory"
},
{
"name": "IQ",
"description": "Iraq"
},
{
"name": "IR",
"description": "Iran"
},
{
"name": "IS",
"description": "Iceland"
},
{
"name": "IT",
"description": "Italy"
},
{
"name": "JE",
"description": "Jersey"
},
{
"name": "JM",
"description": "Jamaica"
},
{
"name": "JO",
"description": "Jordan"
},
{
"name": "JP",
"description": "Japan"
},
{
"name": "KE",
"description": "Kenya"
},
{
"name": "KG",
"description": "Kyrgyzstan"
},
{
"name": "KH",
"description": "Cambodia"
},
{
"name": "KI",
"description": "Kiribati"
},
{
"name": "KM",
"description": "Comoros"
},
{
"name": "KN",
"description": "Saint Kitts and Nevis"
},
{
"name": "KP",
"description": "Democratic People's Republic of Korea"
},
{
"name": "KR",
"description": "Republic of Korea"
},
{
"name": "KW",
"description": "Kuwait"
},
{
"name": "KY",
"description": "Cayman Islands"
},
{
"name": "KZ",
"description": "Kazakhstan"
},
{
"name": "LA",
"description": "Lao People's Democratic Republic"
},
{
"name": "LB",
"description": "Lebanon"
},
{
"name": "LC",
"description": "Saint Lucia"
},
{
"name": "LI",
"description": "Liechtenstein"
},
{
"name": "LK",
"description": "Sri Lanka"
},
{
"name": "LR",
"description": "Liberia"
},
{
"name": "LS",
"description": "Lesotho"
},
{
"name": "LT",
"description": "Lithuania"
},
{
"name": "LU",
"description": "Luxembourg"
},
{
"name": "LV",
"description": "Latvia"
},
{
"name": "LY",
"description": "Libya"
},
{
"name": "MA",
"description": "Morocco"
},
{
"name": "MC",
"description": "Monaco"
},
{
"name": "MD",
"description": "Moldova"
},
{
"name": "ME",
"description": "Montenegro"
},
{
"name": "MF",
"description": "Saint Martin"
},
{
"name": "MG",
"description": "Madagascar"
},
{
"name": "MH",
"description": "Marshall Islands"
},
{
"name": "MK",
"description": "North Macedonia"
},
{
"name": "ML",
"description": "Mali"
},
{
"name": "MM",
"description": "Myanmar"
},
{
"name": "MN",
"description": "Mongolia"
},
{
"name": "MO",
"description": "Macao"
},
{
"name": "MP",
"description": "Northern Mariana Islands"
},
{
"name": "MQ",
"description": "Martinique"
},
{
"name": "MR",
"description": "Mauritania"
},
{
"name": "MS",
"description": "Montserrat"
},
{
"name": "MT",
"description": "Malta"
},
{
"name": "MU",
"description": "Mauritius"
},
{
"name": "MV",
"description": "Maldives"
},
{
"name": "MW",
"description": "Malawi"
},
{
"name": "MX",
"description": "Mexico"
},
{
"name": "MY",
"description": "Malaysia"
},
{
"name": "MZ",
"description": "Mozambique"
},
{
"name": "NA",
"description": "Namibia"
},
{
"name": "NC",
"description": "New Caledonia"
},
{
"name": "NE",
"description": "Niger"
},
{
"name": "NF",
"description": "Norfolk Island"
},
{
"name": "NG",
"description": "Nigeria"
},
{
"name": "NI",
"description": "Nicaragua"
},
{
"name": "NL",
"description": "Netherlands"
},
{
"name": "NO",
"description": "Norway"
},
{
"name": "NP",
"description": "Nepal"
},
{
"name": "NR",
"description": "Nauru"
},
{
"name": "NU",
"description": "Niue"
},
{
"name": "NZ",
"description": "New Zealand"
},
{
"name": "OM",
"description": "Oman"
},
{
"name": "PA",
"description": "Panama"
},
{
"name": "PE",
"description": "Peru"
},
{
"name": "PF",
"description": "French Polynesia"
},
{
"name": "PG",
"description": "Papua New Guinea"
},
{
"name": "PH",
"description": "Philippines"
},
{
"name": "PK",
"description": "Pakistan"
},
{
"name": "PL",
"description": "Poland"
},
{
"name": "PM",
"description": "Saint Pierre and Miquelon"
},
{
"name": "PN",
"description": "Pitcairn"
},
{
"name": "PR",
"description": "Puerto Rico"
},
{
"name": "PS",
"description": "Palestine"
},
{
"name": "PT",
"description": "Portugal"
},
{
"name": "PW",
"description": "Palau"
},
{
"name": "PY",
"description": "Paraguay"
},
{
"name": "QA",
"description": "Qatar"
},
{
"name": "RE",
"description": "Réunion"
},
{
"name": "RO",
"description": "Romania"
},
{
"name": "RS",
"description": "Serbia"
},
{
"name": "RU",
"description": "Russia"
},
{
"name": "RW",
"description": "Rwanda"
},
{
"name": "SA",
"description": "Saudi Arabia"
},
{
"name": "SB",
"description": "Solomon Islands"
},
{
"name": "SC",
"description": "Seychelles"
},
{
"name": "SD",
"description": "Sudan"
},
{
"name": "SE",
"description": "Sweden"
},
{
"name": "SG",
"description": "Singapore"
},
{
"name": "SH",
"description": "Saint Helena, Ascension and Tristan da Cunha"
},
{
"name": "SI",
"description": "Slovenia"
},
{
"name": "SJ",
"description": "Svalbard and Jan Mayen"
},
{
"name": "SK",
"description": "Slovakia"
},
{
"name": "SL",
"description": "Sierra Leone"
},
{
"name": "SM",
"description": "San Marino"
},
{
"name": "SN",
"description": "Senegal"
},
{
"name": "SO",
"description": "Somalia"
},
{
"name": "SR",
"description": "Suriname"
},
{
"name": "SS",
"description": "South Sudan"
},
{
"name": "ST",
"description": "Sao Tome and Principe"
},
{
"name": "SV",
"description": "El Salvador"
},
{
"name": "SX",
"description": "Sint Maarten"
},
{
"name": "SY",
"description": "Syrian Arab Republic"
},
{
"name": "SZ",
"description": "Eswatini"
},
{
"name": "TC",
"description": "Turks and Caicos Islands"
},
{
"name": "TD",
"description": "Chad"
},
{
"name": "TF",
"description": "French Southern Territories"
},
{
"name": "TG",
"description": "Togo"
},
{
"name": "TH",
"description": "Thailand"
},
{
"name": "TJ",
"description": "Tajikistan"
},
{
"name": "TK",
"description": "Tokelau"
},
{
"name": "TL",
"description": "Timor-Leste"
},
{
"name": "TM",
"description": "Turkmenistan"
},
{
"name": "TN",
"description": "Tunisia"
},
{
"name": "TO",
"description": "Tonga"
},
{
"name": "TR",
"description": "Turkey"
},
{
"name": "TT",
"description": "Trinidad and Tobago"
},
{
"name": "TV",
"description": "Tuvalu"
},
{
"name": "TW",
"description": "Taiwan"
},
{
"name": "TZ",
"description": "Tanzania"
},
{
"name": "UA",
"description": "Ukraine"
},
{
"name": "UG",
"description": "Uganda"
},
{
"name": "UM",
"description": "United States Minor Outlying Islands"
},
{
"name": "US",
"description": "United States of America"
},
{
"name": "UY",
"description": "Uruguay"
},
{
"name": "UZ",
"description": "Uzbekistan"
},
{
"name": "VA",
"description": "Vatican City"
},
{
"name": "VC",
"description": "Saint Vincent and the Grenadines"
},
{
"name": "VE",
"description": "Venezuela"
},
{
"name": "VG",
"description": "British Virgin Islands"
},
{
"name": "VI",
"description": "U.S. Virgin Islands"
},
{
"name": "VN",
"description": "Vietnam"
},
{
"name": "VU",
"description": "Vanuatu"
},
{
"name": "WF",
"description": "Wallis and Futuna"
},
{
"name": "WS",
"description": "Samoa"
},
{
"name": "YE",
"description": "Yemen"
},
{
"name": "YT",
"description": "Mayotte"
},
{
"name": "ZA",
"description": "South Africa"
},
{
"name": "ZM",
"description": "Zambia"
},
{
"name": "ZW",
"description": "Zimbabwe"
}
],
"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).",
"x-release-status": "PUBLIC"
},
"CustomerAddressFilter": {
"type": "object",
"description": "The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when\nsearching by an `Address`-type custom attribute.",
"x-release-status": "PUBLIC",
"properties": {
"postal_code": {
"$ref": "#/$defs/CustomerTextFilter",
"description": "The postal code to search for. Only an `exact` match is supported."
},
"country": {
"$ref": "#/$defs/Country",
"description": "The country code to search for.\nSee [Country](#type-country) for possible values"
}
}
},
"CustomerCreationSource": {
"type": "string",
"enum": [
"OTHER",
"APPOINTMENTS",
"COUPON",
"DELETION_RECOVERY",
"DIRECTORY",
"EGIFTING",
"EMAIL_COLLECTION",
"FEEDBACK",
"IMPORT",
"INVOICES",
"LOYALTY",
"MARKETING",
"MERGE",
"ONLINE_STORE",
"INSTANT_PROFILE",
"TERMINAL",
"THIRD_PARTY",
"THIRD_PARTY_IMPORT",
"UNMERGE_RECOVERY"
],
"x-enum-elements": [
{
"name": "OTHER",
"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."
},
{
"name": "APPOINTMENTS",
"description": "The customer profile was created automatically when an appointment\nwas scheduled."
},
{
"name": "COUPON",
"description": "The customer profile was created automatically when a coupon was issued\nusing Square Point of Sale."
},
{
"name": "DELETION_RECOVERY",
"description": "The customer profile was restored through Square's deletion recovery\nprocess."
},
{
"name": "DIRECTORY",
"description": "The customer profile was created manually through Square Seller Dashboard or the \nPoint of Sale application."
},
{
"name": "EGIFTING",
"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."
},
{
"name": "EMAIL_COLLECTION",
"description": "The customer profile was created through Square Point of Sale when\nsigning up for marketing emails during checkout."
},
{
"name": "FEEDBACK",
"description": "The customer profile was created automatically when providing feedback\nthrough a digital receipt."
},
{
"name": "IMPORT",
"description": "The customer profile was created automatically when importing customer\ndata through Square Seller Dashboard."
},
{
"name": "INVOICES",
"description": "The customer profile was created automatically during an invoice payment."
},
{
"name": "LOYALTY",
"description": "The customer profile was created automatically when customers provide a\nphone number for loyalty reward programs during checkout."
},
{
"name": "MARKETING",
"description": "The customer profile was created as the result of a campaign managed\nthrough Square’s Facebook integration."
},
{
"name": "MERGE",
"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."
},
{
"name": "ONLINE_STORE",
"description": "The customer profile was created through Square's Online Store solution\n(legacy service)."
},
{
"name": "INSTANT_PROFILE",
"description": "The customer profile was created automatically as the result of a successful\ntransaction that did not explicitly link to an existing customer profile."
},
{
"name": "TERMINAL",
"description": "The customer profile was created through Square's Virtual Terminal."
},
{
"name": "THIRD_PARTY",
"description": "The customer profile was created through a Square API call."
},
{
"name": "THIRD_PARTY_IMPORT",
"description": "The customer profile was created by a third-party product and imported\nthrough an official integration."
},
{
"name": "UNMERGE_RECOVERY",
"description": "The customer profile was restored through Square's unmerge recovery\nprocess."
}
],
"description": "Indicates the method used to create the customer profile.",
"x-release-status": "PUBLIC"
},
"CustomerCreationSourceFilter": {
"type": "object",
"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.",
"x-release-status": "PUBLIC",
"properties": {
"values": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CustomerCreationSource"
},
"description": "The list of creation sources used as filtering criteria.\nSee [CustomerCreationSou
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-search-customers-request-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/square-search-customers-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.