{ "info": { "_postman_id": "85e4367c-86a2-470e-9136-3db809a8f5b1", "name": "Square ApplePay CustomerSegments 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:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "lastUpdatedBy": "35240", "uid": "35240-85e4367c-86a2-470e-9136-3db809a8f5b1" }, "item": [ { "name": "v2", "item": [ { "name": "customers", "item": [ { "name": "segments", "item": [ { "name": "{segment_id}", "item": [ { "name": "Square Retrieve Customer Segment", "id": "3317e368-4768-4c77-8872-160db0c4ccf3", "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/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "segments", ":segment_id" ], "variable": [ { "id": "45a46d4e-472f-437d-801f-2a5b7aa3d8a3", "key": "segment_id", "value": "", "description": "(Required) The Square-issued ID of the customer segment." } ] }, "description": "Retrieves a specific customer segment as identified by the `segment_id` value." }, "response": [ { "id": "6675d468-e7e3-4a60-a9db-4b5ab5720309", "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/segments/:segment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "segments", ":segment_id" ], "variable": [ { "key": "segment_id" } ] } }, "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\": \"ADDRESS_VERIFICATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"CARD_PRESENCE_REQUIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"segment\": {\n \"name\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-6675d468-e7e3-4a60-a9db-4b5ab5720309" } ], "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-3317e368-4768-4c77-8872-160db0c4ccf3" } ], "id": "148b575e-900d-4534-b916-e24ecdeeb3da", "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-148b575e-900d-4534-b916-e24ecdeeb3da" }, { "name": "Square List Customer Segments", "id": "36bd62df-5e77-4876-ba9b-fd82585a9521", "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/segments?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "segments" ], "query": [ { "description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\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 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "limit", "value": "" } ] }, "description": "Retrieves the list of customer segments of a business." }, "response": [ { "id": "b859dc2f-d8ef-4bf3-a454-739d9c130406", "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/segments?cursor=&limit=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "customers", "segments" ], "query": [ { "description": "A pagination cursor returned by previous calls to `ListCustomerSegments`.\nThis cursor is used to retrieve the next set of query results.\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 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).", "key": "limit", "value": "" } ] } }, "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\": \"CARD_DECLINED_CALL_ISSUER\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"INVALID_EMAIL_ADDRESS\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"segments\": [\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"name\": \"\",\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-b859dc2f-d8ef-4bf3-a454-739d9c130406" } ], "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-36bd62df-5e77-4876-ba9b-fd82585a9521" } ], "id": "0d1de68a-822d-4baf-8cea-3650e97a474a", "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-0d1de68a-822d-4baf-8cea-3650e97a474a" } ], "id": "a13b1196-14a5-46f8-bab0-cddf8d9c4910", "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-a13b1196-14a5-46f8-bab0-cddf8d9c4910" } ], "id": "141f3553-7224-4c8c-a7e9-658d3b8bc0c0", "createdAt": "2026-07-28T03:02:21.000Z", "updatedAt": "2026-07-28T03:02:21.000Z", "uid": "35240-141f3553-7224-4c8c-a7e9-658d3b8bc0c0" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }