{ "info": { "_postman_id": "fd3c31b8-b35c-45f5-bb4d-81d27d0638ad", "name": "Square ApplePay Devices 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:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "lastUpdatedBy": "35240", "uid": "35240-fd3c31b8-b35c-45f5-bb4d-81d27d0638ad" }, "item": [ { "name": "v2", "item": [ { "name": "devices", "item": [ { "name": "codes", "item": [ { "name": "{id}", "item": [ { "name": "Square Get Device Code", "id": "324fe264-61b7-4264-acb7-c9a2de18b267", "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/devices/codes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", "codes", ":id" ], "variable": [ { "id": "6b9e342f-194e-4208-87f5-13f5adec0e7d", "key": "id", "value": "", "description": "(Required) The unique identifier for the device code." } ] }, "description": "Retrieves DeviceCode with the associated ID." }, "response": [ { "id": "58c870c4-ecb0-4565-8b11-ff0bafce3191", "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/devices/codes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", "codes", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"NOT_IMPLEMENTED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"ARRAY_LENGTH_TOO_LONG\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"device_code\": {\n \"product_type\": \"TERMINAL_API\",\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"device_id\": \"\",\n \"location_id\": \"\",\n \"status\": \"EXPIRED\",\n \"pair_by\": \"\",\n \"created_at\": \"\",\n \"status_changed_at\": \"\",\n \"paired_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:02:23.000Z", "updatedAt": "2026-07-28T03:02:23.000Z", "uid": "35240-58c870c4-ecb0-4565-8b11-ff0bafce3191" } ], "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-324fe264-61b7-4264-acb7-c9a2de18b267" } ], "id": "67bdae38-b01d-418e-be46-8764b4685a73", "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-67bdae38-b01d-418e-be46-8764b4685a73" }, { "name": "Square List Device Codes", "id": "bf0a0bec-f998-445f-af32-51c8c200231f", "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/devices/codes?cursor=&location_id=&product_type=TERMINAL_API&status=UNPAIRED", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", "codes" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.", "key": "cursor", "value": "" }, { "description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty.", "key": "location_id", "value": "" }, { "description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty.", "key": "product_type", "value": "TERMINAL_API" }, { "description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.", "key": "status", "value": "UNPAIRED" } ] }, "description": "Lists all DeviceCodes associated with the merchant." }, "response": [ { "id": "854de5a9-a7ca-4131-b292-d9875a392720", "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/devices/codes?cursor=&location_id=&product_type=TERMINAL_API&status=UNPAIRED", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", "codes" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this to retrieve the next set of results for your original query.\n\nSee [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.", "key": "cursor", "value": "" }, { "description": "If specified, only returns DeviceCodes of the specified location.\nReturns DeviceCodes of all locations if empty.", "key": "location_id", "value": "" }, { "description": "If specified, only returns DeviceCodes targeting the specified product type.\nReturns DeviceCodes of all product types if empty.", "key": "product_type", "value": "TERMINAL_API" }, { "description": "If specified, returns DeviceCodes with the specified statuses.\nReturns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.", "key": "status", "value": "UNPAIRED" } ] } }, "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\": \"NOT_IMPLEMENTED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"PLAID_ERROR_ITEM_LOGIN_REQUIRED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"device_codes\": [\n {\n \"product_type\": \"TERMINAL_API\",\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"device_id\": \"\",\n \"location_id\": \"\",\n \"status\": \"UNKNOWN\",\n \"pair_by\": \"\",\n \"created_at\": \"\",\n \"status_changed_at\": \"\",\n \"paired_at\": \"\"\n },\n {\n \"product_type\": \"TERMINAL_API\",\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"device_id\": \"\",\n \"location_id\": \"\",\n \"status\": \"PAIRED\",\n \"pair_by\": \"\",\n \"created_at\": \"\",\n \"status_changed_at\": \"\",\n \"paired_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:02:23.000Z", "updatedAt": "2026-07-28T03:02:23.000Z", "uid": "35240-854de5a9-a7ca-4131-b292-d9875a392720" } ], "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-bf0a0bec-f998-445f-af32-51c8c200231f" }, { "name": "Square Create Device Code", "id": "d48ce737-3a63-46d8-a753-4978884183b4", "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 \"device_code\": {\n \"product_type\": \"TERMINAL_API\",\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"device_id\": \"\",\n \"location_id\": \"\",\n \"status\": \"PAIRED\",\n \"pair_by\": \"\",\n \"created_at\": \"\",\n \"status_changed_at\": \"\",\n \"paired_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/devices/codes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", "codes" ] }, "description": "Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected\nterminal mode." }, "response": [ { "id": "3b2329ee-92e0-42c2-8569-eb034c9621f1", "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 \"device_code\": {\n \"product_type\": \"TERMINAL_API\",\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"device_id\": \"\",\n \"location_id\": \"\",\n \"status\": \"PAIRED\",\n \"pair_by\": \"\",\n \"created_at\": \"\",\n \"status_changed_at\": \"\",\n \"paired_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/devices/codes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", "codes" ] } }, "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\": \"EXPIRATION_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"RATE_LIMITED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"device_code\": {\n \"product_type\": \"TERMINAL_API\",\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"device_id\": \"\",\n \"location_id\": \"\",\n \"status\": \"PAIRED\",\n \"pair_by\": \"\",\n \"created_at\": \"\",\n \"status_changed_at\": \"\",\n \"paired_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:02:23.000Z", "updatedAt": "2026-07-28T03:02:23.000Z", "uid": "35240-3b2329ee-92e0-42c2-8569-eb034c9621f1" } ], "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-d48ce737-3a63-46d8-a753-4978884183b4" } ], "id": "bc4aadf2-c24f-44ee-bcd9-32ec36515457", "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-bc4aadf2-c24f-44ee-bcd9-32ec36515457" }, { "name": "{device_id}", "item": [ { "name": "Square Get Device", "id": "d56a090c-e4e4-4ae2-972f-4071e5af70bc", "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/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", ":device_id" ], "variable": [ { "id": "4e348b21-de52-4df4-b581-ee03ea885e3c", "key": "device_id", "value": "", "description": "(Required) The unique ID for the desired `Device`." } ] }, "description": "Retrieves Device with the associated `device_id`." }, "response": [ { "id": "40b3e770-9521-4574-9d4e-360d2ffc9f97", "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/devices/:device_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices", ":device_id" ], "variable": [ { "key": "device_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"DELAYED_TRANSACTION_CANCELED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_CURSOR\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"device\": {\n \"attributes\": {\n \"type\": \"TERMINAL\",\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"name\": \"\",\n \"manufacturers_id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"merchant_token\": \"\"\n },\n \"id\": \"\",\n \"components\": [\n {\n \"type\": \"WIFI\",\n \"application_details\": {\n \"application_type\": \"TERMINAL_API\",\n \"version\": \"\",\n \"session_location\": \"\",\n \"device_code_id\": \"\"\n },\n \"card_reader_details\": {\n \"version\": \"\"\n },\n \"battery_details\": {\n \"visible_percent\": \"\",\n \"external_power\": \"UNAVAILABLE\"\n },\n \"wifi_details\": {\n \"active\": \"\",\n \"ssid\": \"\",\n \"ip_address_v4\": \"\",\n \"secure_connection\": \"\",\n \"signal_strength\": {\n \"value\": \"\"\n }\n },\n \"ethernet_details\": {\n \"active\": \"\",\n \"ip_address_v4\": \"\"\n }\n },\n {\n \"type\": \"WIFI\",\n \"application_details\": {\n \"application_type\": \"TERMINAL_API\",\n \"version\": \"\",\n \"session_location\": \"\",\n \"device_code_id\": \"\"\n },\n \"card_reader_details\": {\n \"version\": \"\"\n },\n \"battery_details\": {\n \"visible_percent\": \"\",\n \"external_power\": \"UNAVAILABLE\"\n },\n \"wifi_details\": {\n \"active\": \"\",\n \"ssid\": \"\",\n \"ip_address_v4\": \"\",\n \"secure_connection\": \"\",\n \"signal_strength\": {\n \"value\": \"\"\n }\n },\n \"ethernet_details\": {\n \"active\": \"\",\n \"ip_address_v4\": \"\"\n }\n }\n ],\n \"status\": {\n \"category\": \"NEEDS_ATTENTION\"\n }\n }\n}", "createdAt": "2026-07-28T03:02:23.000Z", "updatedAt": "2026-07-28T03:02:23.000Z", "uid": "35240-40b3e770-9521-4574-9d4e-360d2ffc9f97" } ], "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-d56a090c-e4e4-4ae2-972f-4071e5af70bc" } ], "id": "d90331aa-70eb-4e4f-9148-9eef30782613", "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-d90331aa-70eb-4e4f-9148-9eef30782613" }, { "name": "Square List Devices", "id": "8c8e0451-02ce-4615-b2ce-3013492a89d9", "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/devices?cursor=&sort_order=ASC&limit=&location_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", "key": "cursor", "value": "" }, { "description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", "key": "sort_order", "value": "ASC" }, { "description": "The number of results to return in a single page.", "key": "limit", "value": "" }, { "description": "If present, only returns devices at the target location.", "key": "location_id", "value": "" } ] }, "description": "List devices associated with the merchant. Currently, only Terminal API\ndevices are supported." }, "response": [ { "id": "0fde6018-2953-4dcb-9890-102f4588eb0d", "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/devices?cursor=&sort_order=ASC&limit=&location_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "devices" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint.\nProvide this cursor to retrieve the next set of results for the original query.\nSee [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.", "key": "cursor", "value": "" }, { "description": "The order in which results are listed.\n- `ASC` - Oldest to newest.\n- `DESC` - Newest to oldest (default).", "key": "sort_order", "value": "ASC" }, { "description": "The number of results to return in a single page.", "key": "limit", "value": "" }, { "description": "If present, only returns devices at the target location.", "key": "location_id", "value": "" } ] } }, "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\": \"CUSTOMER_MISSING_EMAIL\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"FORBIDDEN\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"devices\": [\n {\n \"attributes\": {\n \"type\": \"TERMINAL\",\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"name\": \"\",\n \"manufacturers_id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"merchant_token\": \"\"\n },\n \"id\": \"\",\n \"components\": [\n {\n \"type\": \"PRINTER\",\n \"application_details\": {\n \"application_type\": \"TERMINAL_API\",\n \"version\": \"\",\n \"session_location\": \"\",\n \"device_code_id\": \"\"\n },\n \"card_reader_details\": {\n \"version\": \"\"\n },\n \"battery_details\": {\n \"visible_percent\": \"\",\n \"external_power\": \"AVAILABLE_INSUFFICIENT\"\n },\n \"wifi_details\": {\n \"active\": \"\",\n \"ssid\": \"\",\n \"ip_address_v4\": \"\",\n \"secure_connection\": \"\",\n \"signal_strength\": {\n \"value\": \"\"\n }\n },\n \"ethernet_details\": {\n \"active\": \"\",\n \"ip_address_v4\": \"\"\n }\n },\n {\n \"type\": \"CARD_READER\",\n \"application_details\": {\n \"application_type\": \"TERMINAL_API\",\n \"version\": \"\",\n \"session_location\": \"\",\n \"device_code_id\": \"\"\n },\n \"card_reader_details\": {\n \"version\": \"\"\n },\n \"battery_details\": {\n \"visible_percent\": \"\",\n \"external_power\": \"AVAILABLE_CHARGING\"\n },\n \"wifi_details\": {\n \"active\": \"\",\n \"ssid\": \"\",\n \"ip_address_v4\": \"\",\n \"secure_connection\": \"\",\n \"signal_strength\": {\n \"value\": \"\"\n }\n },\n \"ethernet_details\": {\n \"active\": \"\",\n \"ip_address_v4\": \"\"\n }\n }\n ],\n \"status\": {\n \"category\": \"AVAILABLE\"\n }\n },\n {\n \"attributes\": {\n \"type\": \"TERMINAL\",\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"name\": \"\",\n \"manufacturers_id\": \"\",\n \"updated_at\": \"\",\n \"version\": \"\",\n \"merchant_token\": \"\"\n },\n \"id\": \"\",\n \"components\": [\n {\n \"type\": \"ETHERNET\",\n \"application_details\": {\n \"application_type\": \"TERMINAL_API\",\n \"version\": \"\",\n \"session_location\": \"\",\n \"device_code_id\": \"\"\n },\n \"card_reader_details\": {\n \"version\": \"\"\n },\n \"battery_details\": {\n \"visible_percent\": \"\",\n \"external_power\": \"AVAILABLE_INSUFFICIENT\"\n },\n \"wifi_details\": {\n \"active\": \"\",\n \"ssid\": \"\",\n \"ip_address_v4\": \"\",\n \"secure_connection\": \"\",\n \"signal_strength\": {\n \"value\": \"\"\n }\n },\n \"ethernet_details\": {\n \"active\": \"\",\n \"ip_address_v4\": \"\"\n }\n },\n {\n \"type\": \"WIFI\",\n \"application_details\": {\n \"application_type\": \"TERMINAL_API\",\n \"version\": \"\",\n \"session_location\": \"\",\n \"device_code_id\": \"\"\n },\n \"card_reader_details\": {\n \"version\": \"\"\n },\n \"battery_details\": {\n \"visible_percent\": \"\",\n \"external_power\": \"AVAILABLE_CHARGING\"\n },\n \"wifi_details\": {\n \"active\": \"\",\n \"ssid\": \"\",\n \"ip_address_v4\": \"\",\n \"secure_connection\": \"\",\n \"signal_strength\": {\n \"value\": \"\"\n }\n },\n \"ethernet_details\": {\n \"active\": \"\",\n \"ip_address_v4\": \"\"\n }\n }\n ],\n \"status\": {\n \"category\": \"OFFLINE\"\n }\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T03:02:23.000Z", "updatedAt": "2026-07-28T03:02:23.000Z", "uid": "35240-0fde6018-2953-4dcb-9890-102f4588eb0d" } ], "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-8c8e0451-02ce-4615-b2ce-3013492a89d9" } ], "id": "dc6a5e73-a6d7-454d-bc54-915d89e96456", "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-dc6a5e73-a6d7-454d-bc54-915d89e96456" } ], "id": "29b496d0-6af4-44b7-aa61-db8c87d34900", "createdAt": "2026-07-28T03:02:22.000Z", "updatedAt": "2026-07-28T03:02:22.000Z", "uid": "35240-29b496d0-6af4-44b7-aa61-db8c87d34900" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }