{ "info": { "_postman_id": "7c871c16-6867-4c75-90af-a676adb03816", "name": "Square ApplePay Customers API", "description": "Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. \n\nContact Support:\n Name: Square Developer Platform\n Email: developers@squareup.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "lastUpdatedBy": "35240", "uid": "35240-7c871c16-6867-4c75-90af-a676adb03816" }, "item": [ { "name": "v2", "item": [ { "name": "customers", "item": [ { "name": "bulk-create", "item": [ { "name": "Square Bulk Create Customers", "id": "1e436357-bfcb-4b63-8eec-fc17d76bf45c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customers\": {\n \"proident9\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"TL\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-create", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-create" ] }, "description": "Creates multiple [customer profiles](entity:Customer) for a business.\n\nThis endpoint takes a map of individual create requests and returns a map of responses.\n\nYou must provide at least one of the following values in each create request:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`" }, "response": [ { "id": "c4a3bd08-b567-4119-9ad5-e8d35af86814", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customers\": {\n \"proident9\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"TL\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-create", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"responses\": {\n \"pariature\": {\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"ACCOUNT_UNUSABLE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"NR\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"MARKETING\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n }\n },\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"CVV_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-c4a3bd08-b567-4119-9ad5-e8d35af86814" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-1e436357-bfcb-4b63-8eec-fc17d76bf45c" } ], "id": "5622cbd3-6c83-4494-a155-01689df7df91", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-5622cbd3-6c83-4494-a155-01689df7df91" }, { "name": "bulk-delete", "item": [ { "name": "Square Bulk Delete Customers", "id": "f2817977-b806-4be9-a38f-c1c81d4316d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-delete" ] }, "description": "Deletes multiple customer profiles.\n\nThe endpoint takes a list of customer IDs and returns a map of responses." }, "response": [ { "id": "9d5d86ef-6bbd-4662-ada4-ea6958fef7cb", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-delete", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-delete" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"responses\": {\n \"dolore_d\": {\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"PAN_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n \"culpa_5\": {\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"ADDRESS_VERIFICATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n },\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"CARD_TOKEN_USED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-9d5d86ef-6bbd-4662-ada4-ea6958fef7cb" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-f2817977-b806-4be9-a38f-c1c81d4316d7" } ], "id": "26ffa10c-7396-4dd5-b016-a6433b1dabbd", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-26ffa10c-7396-4dd5-b016-a6433b1dabbd" }, { "name": "bulk-retrieve", "item": [ { "name": "Square Bulk Retrieve Customers", "id": "d9861432-9b7e-4171-92a4-688b1f989a52", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-retrieve", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-retrieve" ] }, "description": "Retrieves multiple customer profiles.\n\nThis endpoint takes a list of customer IDs and returns a map of responses." }, "response": [ { "id": "1638918d-688b-4e84-9304-cdb6b1658e63", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customer_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-retrieve", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-retrieve" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"responses\": {\n \"anim_e\": {\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"ADDRESS_VERIFICATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"US\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"INSTANT_PROFILE\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n },\n \"id_c\": {\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"REQUEST_ENTITY_TOO_LARGE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"UA\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"APPOINTMENTS\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n },\n \"anim_51\": {\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"VALUE_TOO_LOW\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"MF\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"OTHER\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n }\n },\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"APPLICATION_DISABLED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-1638918d-688b-4e84-9304-cdb6b1658e63" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-d9861432-9b7e-4171-92a4-688b1f989a52" } ], "id": "26049043-f1ba-49c5-8a3b-f606d956d7df", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-26049043-f1ba-49c5-8a3b-f606d956d7df" }, { "name": "bulk-update", "item": [ { "name": "Square Bulk Update Customers", "id": "21cead51-7526-4dec-b7c6-340731ad229a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customers\": {\n \"fugiat_0de\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"UZ\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n },\n \"version\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-update", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-update" ] }, "description": "Updates multiple customer profiles.\n\nThis endpoint takes a map of individual update requests and returns a map of responses." }, "response": [ { "id": "719b008e-533f-4502-9ba2-2dedc680e380", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"customers\": {\n \"fugiat_0de\": {\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"UZ\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n },\n \"version\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/bulk-update", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "bulk-update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"responses\": {\n \"ut_efe\": {\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"INVALID_ACCOUNT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"FK\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"TERMINAL\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n },\n \"laborum5eb\": {\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CHIP_INSERTION_REQUIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"AG\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"IMPORT\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n },\n \"do_c\": {\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"ACCESS_TOKEN_REVOKED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"BY\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"THIRD_PARTY_IMPORT\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n },\n \"occaecatbf\": {\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"SOURCE_USED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"MM\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"ONLINE_STORE\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n },\n \"Ut_614\": {\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"EXPIRATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"TT\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"ONLINE_STORE\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n }\n },\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"INVALID_PAUSE_LENGTH\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-719b008e-533f-4502-9ba2-2dedc680e380" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-21cead51-7526-4dec-b7c6-340731ad229a" } ], "id": "6c7c3f6d-079f-426c-88e8-bdc02d281522", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-6c7c3f6d-079f-426c-88e8-bdc02d281522" }, { "name": "search", "item": [ { "name": "Square Search Customers", "id": "5e12e644-a422-4fb4-b462-4ebd281f218e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cursor\": \"\",\n \"limit\": \"\",\n \"query\": {\n \"filter\": {\n \"creation_source\": {\n \"values\": [\n \"UNMERGE_RECOVERY\",\n \"ONLINE_STORE\"\n ],\n \"rule\": \"INCLUDE\"\n },\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"updated_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"email_address\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"phone_number\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"reference_id\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"group_ids\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n },\n \"custom_attribute\": {\n \"filters\": [\n {\n \"key\": \"\",\n \"filter\": {\n \"email\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"phone\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"text\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"selection\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n },\n \"date\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"number\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"boolean\": \"\",\n \"address\": {\n \"postal_code\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"country\": \"WS\"\n }\n },\n \"updated_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"filter\": {\n \"email\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"phone\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"text\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"selection\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n },\n \"date\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"number\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"boolean\": \"\",\n \"address\": {\n \"postal_code\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"country\": \"SK\"\n }\n },\n \"updated_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n }\n ]\n },\n \"segment_ids\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n }\n },\n \"sort\": {\n \"field\": \"CREATED_AT\",\n \"order\": \"ASC\"\n }\n },\n \"count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "search" ] }, "description": "Searches the customer profiles associated with a Square account using one or more supported query filters.\n\nCalling `SearchCustomers` without any explicit query filter returns all\ncustomer profiles ordered alphabetically based on `given_name` and\n`family_name`.\n\nUnder normal operating conditions, newly created or updated customer profiles become available\nfor the search operation in well under 30 seconds. Occasionally, propagation of the new or updated\nprofiles can take closer to one minute or longer, especially during network incidents and outages." }, "response": [ { "id": "2459f37d-7020-4ec2-945c-5d401c289cb0", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cursor\": \"\",\n \"limit\": \"\",\n \"query\": {\n \"filter\": {\n \"creation_source\": {\n \"values\": [\n \"UNMERGE_RECOVERY\",\n \"ONLINE_STORE\"\n ],\n \"rule\": \"INCLUDE\"\n },\n \"created_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"updated_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"email_address\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"phone_number\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"reference_id\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"group_ids\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n },\n \"custom_attribute\": {\n \"filters\": [\n {\n \"key\": \"\",\n \"filter\": {\n \"email\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"phone\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"text\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"selection\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n },\n \"date\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"number\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"boolean\": \"\",\n \"address\": {\n \"postal_code\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"country\": \"WS\"\n }\n },\n \"updated_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n },\n {\n \"key\": \"\",\n \"filter\": {\n \"email\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"phone\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"text\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"selection\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n },\n \"date\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"number\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"boolean\": \"\",\n \"address\": {\n \"postal_code\": {\n \"exact\": \"\",\n \"fuzzy\": \"\"\n },\n \"country\": \"SK\"\n }\n },\n \"updated_at\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n }\n }\n ]\n },\n \"segment_ids\": {\n \"all\": [\n \"\",\n \"\"\n ],\n \"any\": [\n \"\",\n \"\"\n ],\n \"none\": [\n \"\",\n \"\"\n ]\n }\n },\n \"sort\": {\n \"field\": \"CREATED_AT\",\n \"order\": \"ASC\"\n }\n },\n \"count\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"RESERVATION_DECLINED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customers\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"MR\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"UNMERGE_RECOVERY\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n ],\n \"cursor\": \"\",\n \"count\": \"\"\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-2459f37d-7020-4ec2-945c-5d401c289cb0" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-5e12e644-a422-4fb4-b462-4ebd281f218e" } ], "id": "80400991-98f6-47eb-9a69-7462e8fb8071", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-80400991-98f6-47eb-9a69-7462e8fb8071" }, { "name": "{customer_id}", "item": [ { "name": "cards", "item": [ { "name": "{card_id}", "item": [ { "name": "Square Delete Customer Card", "id": "02453285-92ad-44b9-9b3e-e8008840fac8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/cards/:card_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "cards", ":card_id" ], "variable": [ { "id": "f5461384-1d56-46cb-a332-c83508c8f7a7", "key": "customer_id", "value": "", "description": "(Required) The ID of the customer that the card on file belongs to." }, { "id": "89f5aba4-2481-417e-a9da-207f2f154072", "key": "card_id", "value": "", "description": "(Required) The ID of the card on file to delete." } ] }, "description": "Removes a card on file from a customer." }, "response": [ { "id": "2a86356f-111b-4697-9319-0037940e2561", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/cards/:card_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "cards", ":card_id" ], "variable": [ { "key": "customer_id" }, { "key": "card_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"VERIFY_AVS_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"BAD_REQUEST\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-2a86356f-111b-4697-9319-0037940e2561" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-02453285-92ad-44b9-9b3e-e8008840fac8" } ], "id": "7dceb68b-89be-40b9-a8e3-45eb970c2fec", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-7dceb68b-89be-40b9-a8e3-45eb970c2fec" }, { "name": "Square Create Customer Card", "id": "2f7a9bed-802b-49f9-afb3-15adc1caa044", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"card_nonce\": \"\",\n \"billing_address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"NC\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"cardholder_name\": \"\",\n \"verification_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/cards", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "cards" ], "variable": [ { "id": "933b15b4-d223-4494-b008-6d592c0952a4", "key": "customer_id", "value": "", "description": "(Required) The Square ID of the customer profile the card is linked to." } ] }, "description": "Adds a card on file to an existing customer.\n\nAs with charges, calls to `CreateCustomerCard` are idempotent. Multiple\ncalls with the same card nonce return the same card record that was created\nwith the provided nonce during the _first_ call." }, "response": [ { "id": "dfe5ba16-ad70-4fb1-9249-e3c901966c7f", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"card_nonce\": \"\",\n \"billing_address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"NC\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"cardholder_name\": \"\",\n \"verification_token\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/cards", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "cards" ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"GATEWAY_TIMEOUT\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"ACCESS_TOKEN_REVOKED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"card\": {\n \"id\": \"\",\n \"card_brand\": \"OTHER_BRAND\",\n \"last_4\": \"\",\n \"exp_month\": \"\",\n \"exp_year\": \"\",\n \"cardholder_name\": \"\",\n \"billing_address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"JM\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"fingerprint\": \"\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"reference_id\": \"\",\n \"enabled\": \"\",\n \"card_type\": \"UNKNOWN_CARD_TYPE\",\n \"prepaid_type\": \"UNKNOWN_PREPAID_TYPE\",\n \"bin\": \"\",\n \"version\": \"\",\n \"card_co_brand\": \"AFTERPAY\"\n }\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-dfe5ba16-ad70-4fb1-9249-e3c901966c7f" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-2f7a9bed-802b-49f9-afb3-15adc1caa044" } ], "id": "bff7f1e1-2de0-4692-9d82-35839f036c89", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-bff7f1e1-2de0-4692-9d82-35839f036c89" }, { "name": "groups", "item": [ { "name": "{group_id}", "item": [ { "name": "Square Remove Group from Customer", "id": "4ab185da-0827-4bc1-be6f-38fae01ddd77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "groups", ":group_id" ], "variable": [ { "id": "c88cddb5-8f10-4acd-943d-9bb6262dd436", "key": "customer_id", "value": "", "description": "(Required) The ID of the customer to remove from the group." }, { "id": "b32c9d8d-fa54-4c9b-96fc-9e262d5e9a43", "key": "group_id", "value": "", "description": "(Required) The ID of the customer group to remove the customer from." } ] }, "description": "Removes a group membership from a customer.\n\nThe customer is identified by the `customer_id` value\nand the customer group is identified by the `group_id` value." }, "response": [ { "id": "d56ff238-da95-4ecb-943e-ec33dea6fb4a", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "groups", ":group_id" ], "variable": [ { "key": "customer_id" }, { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"INVALID_PAUSE_LENGTH\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"INVALID_PIN\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-d56ff238-da95-4ecb-943e-ec33dea6fb4a" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-4ab185da-0827-4bc1-be6f-38fae01ddd77" }, { "name": "Square Add Group to Customer", "id": "f7cabdc9-2459-4cf4-aeac-3362179ddf64", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "groups", ":group_id" ], "variable": [ { "id": "65fa9323-614d-41cc-afca-c74b46f23d79", "key": "customer_id", "value": "", "description": "(Required) The ID of the customer to add to a group." }, { "id": "eb7aa9a0-6419-4e08-9bf9-25eec680bc14", "key": "group_id", "value": "", "description": "(Required) The ID of the customer group to add the customer to." } ] }, "description": "Adds a group membership to a customer.\n\nThe customer is identified by the `customer_id` value\nand the customer group is identified by the `group_id` value." }, "response": [ { "id": "920c0e12-cda1-4dfd-a643-22d8704c494f", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id/groups/:group_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id", "groups", ":group_id" ], "variable": [ { "key": "customer_id" }, { "key": "group_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"INVALID_CARD_DATA\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"TEMPORARY_ERROR\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-920c0e12-cda1-4dfd-a643-22d8704c494f" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-f7cabdc9-2459-4cf4-aeac-3362179ddf64" } ], "id": "9d9db8e5-54d3-4b61-8d3d-878ce2fc4fe9", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-9d9db8e5-54d3-4b61-8d3d-878ce2fc4fe9" } ], "id": "2cf6cda2-d89f-49dc-954d-250e9e6b7b2f", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-2cf6cda2-d89f-49dc-954d-250e9e6b7b2f" }, { "name": "Square Delete Customer", "id": "922bc184-1672-461f-92f7-5261e98f8492", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id?version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id" ], "query": [ { "description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).", "key": "version", "value": "" } ], "variable": [ { "id": "3a24332f-2f6e-40eb-8cdc-df65650ca3f2", "key": "customer_id", "value": "", "description": "(Required) The ID of the customer to delete." } ] }, "description": "Deletes a customer profile from a business.\n\nTo delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile." }, "response": [ { "id": "d2f199c9-983c-44f6-a697-b59c054c5be1", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id?version=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id" ], "query": [ { "description": "The current version of the customer profile.\n\nAs a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).", "key": "version", "value": "" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"CARD_TOKEN_EXPIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"UNEXPECTED_VALUE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-d2f199c9-983c-44f6-a697-b59c054c5be1" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-922bc184-1672-461f-92f7-5261e98f8492" }, { "name": "Square Retrieve Customer", "id": "1e8d368e-cbd5-4796-93f1-76b5d41bc8a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id" ], "variable": [ { "id": "aac1dfcc-dbd9-4529-91fe-b762e6d4ff27", "key": "customer_id", "value": "", "description": "(Required) The ID of the customer to retrieve." } ] }, "description": "Returns details for a single customer." }, "response": [ { "id": "eb6f74ef-fa1c-41b4-ad16-68864714a0bf", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"ADDRESS_VERIFICATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"CH\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"LOYALTY\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-eb6f74ef-fa1c-41b4-ad16-68864714a0bf" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-1e8d368e-cbd5-4796-93f1-76b5d41bc8a2" }, { "name": "Square Update Customer", "id": "561fc4cc-67a5-4f67-9bd3-8b558fbbc606", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"TF\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id" ], "variable": [ { "id": "adcd06ee-1759-4d2b-806f-f90364487940", "key": "customer_id", "value": "", "description": "(Required) The ID of the customer to update." } ] }, "description": "Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request.\nTo add or update a field, specify the new value. To remove a field, specify `null`.\n\nTo update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile." }, "response": [ { "id": "0756070d-317a-44ca-a598-ce32fa7c2407", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"TF\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"IDEMPOTENCY_KEY_REUSED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"KM\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"EGIFTING\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-0756070d-317a-44ca-a598-ce32fa7c2407" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-561fc4cc-67a5-4f67-9bd3-8b558fbbc606" } ], "id": "f9667eb2-c2b5-4230-a2f2-d6639a0116e6", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-f9667eb2-c2b5-4230-a2f2-d6639a0116e6" }, { "name": "Square List Customers", "id": "2176a296-b1de-4f19-8632-c55fa40bbef0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/customers?cursor=&limit=&sort_field=DEFAULT&sort_order=DESC&count=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "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 less than 1 or greater than 100, 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).", "key": "limit", "value": "" }, { "description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`.", "key": "sort_field", "value": "DEFAULT" }, { "description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`.", "key": "sort_order", "value": "DESC" }, { "description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`.", "key": "count", "value": "false" } ] }, "description": "Lists customer profiles associated with a Square account.\n\nUnder normal operating conditions, newly created or updated customer profiles become available\nfor the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated\nprofiles can take closer to one minute or longer, especially during network incidents and outages." }, "response": [ { "id": "5db18997-30d9-4911-b36b-4af9c1df72fa", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v2/customers?cursor=&limit=&sort_field=DEFAULT&sort_order=DESC&count=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for your original query.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "cursor", "value": "" }, { "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 less than 1 or greater than 100, 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).", "key": "limit", "value": "" }, { "description": "Indicates how customers should be sorted.\n\nThe default value is `DEFAULT`.", "key": "sort_field", "value": "DEFAULT" }, { "description": "Indicates whether customers should be sorted in ascending (`ASC`) or\ndescending (`DESC`) order.\n\nThe default value is `ASC`.", "key": "sort_order", "value": "DESC" }, { "description": "Indicates whether to return the total count of customers in the `count` field of the response.\n\nThe default value is `false`.", "key": "count", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"EXPECTED_INTEGER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customers\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"SH\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"ONLINE_STORE\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n ],\n \"cursor\": \"\",\n \"count\": \"\"\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-5db18997-30d9-4911-b36b-4af9c1df72fa" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-2176a296-b1de-4f19-8632-c55fa40bbef0" }, { "name": "Square Create Customer", "id": "3c8efd2f-b598-4c37-a4ed-cf96dcfb13c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "ADDON_CONFIGURATIONS_READ ADDON_CONFIGURATIONS_WRITE APPOINTMENTS_ALL_READ APPOINTMENTS_ALL_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_READ APPOINTMENTS_WRITE BANK_ACCOUNTS_READ CASH_DRAWER_READ CHANNELS_CREATE CHANNELS_READ CHANNELS_UPDATE CUSTOMERS_READ CUSTOMERS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT DISPUTES_READ DISPUTES_WRITE EMPLOYEES_READ EMPLOYEES_WRITE GIFTCARDS_READ GIFTCARDS_WRITE INVENTORY_READ INVENTORY_WRITE INVOICES_READ INVOICES_WRITE ITEMS_READ ITEMS_WRITE LOYALTY_READ LOYALTY_WRITE MERCHANT_PROFILE_READ MERCHANT_PROFILE_WRITE ONLINE_STORE_SITE_READ ONLINE_STORE_SNIPPETS_READ ONLINE_STORE_SNIPPETS_WRITE ORDERS_READ ORDERS_WRITE PAYMENTS_READ PAYMENTS_WRITE PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS PAYMENTS_WRITE_IN_PERSON PAYMENTS_WRITE_SHARED_ONFILE PAYOUTS_READ PERMISSION_SETS_READ PERMISSION_SETS_WRITE RESERVATIONS_READ RESERVATIONS_WRITE RESTAURANT_CHECKS_READ SETTLEMENTS_READ SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE TIMECARDS_READ TIMECARDS_SETTINGS_READ TIMECARDS_SETTINGS_WRITE TIMECARDS_WRITE VENDOR_READ VENDOR_WRITE", "type": "string" }, { "key": "accessTokenUrl", "value": "https://connect.squareup.com/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "https://connect.squareup.com/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"ZA\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers" ] }, "description": "Creates a new customer for a business.\n\nYou must provide at least one of the following values in your request to this\nendpoint:\n\n- `given_name`\n- `family_name`\n- `company_name`\n- `email_address`\n- `phone_number`" }, "response": [ { "id": "b52f30a3-d1b1-4b26-a7b0-04ee66118077", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"company_name\": \"\",\n \"nickname\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"ZA\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"birthday\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/customers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"EXPECTED_FLOAT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"customer\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"given_name\": \"\",\n \"family_name\": \"\",\n \"nickname\": \"\",\n \"company_name\": \"\",\n \"email_address\": \"\",\n \"address\": {\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"address_line_3\": \"\",\n \"locality\": \"\",\n \"sublocality\": \"\",\n \"sublocality_2\": \"\",\n \"sublocality_3\": \"\",\n \"administrative_district_level_1\": \"\",\n \"administrative_district_level_2\": \"\",\n \"administrative_district_level_3\": \"\",\n \"postal_code\": \"\",\n \"country\": \"US\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n \"phone_number\": \"\",\n \"birthday\": \"\",\n \"reference_id\": \"\",\n \"note\": \"\",\n \"preferences\": {\n \"email_unsubscribed\": \"\"\n },\n \"creation_source\": \"DIRECTORY\",\n \"group_ids\": [\n \"\"\n ],\n \"segment_ids\": [\n \"\"\n ],\n \"version\": \"\",\n \"tax_ids\": {\n \"eu_vat\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-b52f30a3-d1b1-4b26-a7b0-04ee66118077" } ], "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-3c8efd2f-b598-4c37-a4ed-cf96dcfb13c5" } ], "id": "7cdf402d-b2bd-47be-a16b-4f52ab62fb20", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-7cdf402d-b2bd-47be-a16b-4f52ab62fb20" } ], "id": "3b75b51f-b80e-4359-a502-000653cee128", "createdAt": "2026-07-28T03:02:20.000Z", "updatedAt": "2026-07-28T03:02:20.000Z", "uid": "35240-3b75b51f-b80e-4359-a502-000653cee128" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }