{ "info": { "_postman_id": "4b716bb7-7a62-42f7-9eff-508b9e9cdba2", "name": "Square ApplePay Labor 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:03:57.000Z", "updatedAt": "2026-07-28T03:03:57.000Z", "lastUpdatedBy": "35240", "uid": "35240-4b716bb7-7a62-42f7-9eff-508b9e9cdba2" }, "item": [ { "name": "v2", "item": [ { "name": "labor", "item": [ { "name": "break-types", "item": [ { "name": "{id}", "item": [ { "name": "Square Delete Break Type", "id": "bbfb0645-a889-4184-b984-b1ad9dafc6fd", "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/labor/break-types/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types", ":id" ], "variable": [ { "id": "67ace4da-f0ad-46bc-bd93-0906defa3f1c", "key": "id", "value": "", "description": "(Required) The UUID for the `BreakType` being deleted." } ] }, "description": "Deletes an existing `BreakType`.\n\nA `BreakType` can be deleted even if it is referenced from a `Shift`." }, "response": [ { "id": "068a9bfb-c619-459c-80c0-061c037e39c2", "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/labor/break-types/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types", ":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\": \"RATE_LIMIT_ERROR\",\n \"code\": \"INVALID_PAUSE_LENGTH\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"INVALID_CARD_DATA\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-068a9bfb-c619-459c-80c0-061c037e39c2" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-bbfb0645-a889-4184-b984-b1ad9dafc6fd" }, { "name": "Square Get Break Type", "id": "fd346d0e-2b80-4bff-8c77-a74578291e8c", "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/labor/break-types/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types", ":id" ], "variable": [ { "id": "7e45af3a-0dea-462a-b16a-12b324b28c26", "key": "id", "value": "", "description": "(Required) The UUID for the `BreakType` being retrieved." } ] }, "description": "Returns a single `BreakType` specified by `id`." }, "response": [ { "id": "9e12067a-d352-4aa5-a3ab-dcb13776ea54", "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/labor/break-types/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"break_type\": {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"MISSING_ACCOUNT_TYPE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"NOT_ACCEPTABLE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-9e12067a-d352-4aa5-a3ab-dcb13776ea54" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-fd346d0e-2b80-4bff-8c77-a74578291e8c" }, { "name": "Square Update Break Type", "id": "678adc88-a11c-48c5-9a8f-c5d377ab4a7f", "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 \"break_type\": {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/break-types/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types", ":id" ], "variable": [ { "id": "1c6cf909-dfad-4f93-841c-649b2a52b77f", "key": "id", "value": "", "description": "(Required) The UUID for the `BreakType` being updated." } ] }, "description": "Updates an existing `BreakType`." }, "response": [ { "id": "42f5e6f4-6271-42ba-894a-117daae87432", "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 \"break_type\": {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/break-types/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"break_type\": {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"VERIFY_CVV_FAILURE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"CURRENCY_MISMATCH\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-42f5e6f4-6271-42ba-894a-117daae87432" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-678adc88-a11c-48c5-9a8f-c5d377ab4a7f" } ], "id": "84f671bd-b03b-4464-a940-723235524bf6", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-84f671bd-b03b-4464-a940-723235524bf6" }, { "name": "Square List Break Types", "id": "1bf80226-abb2-4ca5-bb91-5468543b584f", "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/labor/break-types?location_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types" ], "query": [ { "description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location.", "key": "location_id", "value": "" }, { "description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `BreakType` results to fetch.", "key": "cursor", "value": "" } ] }, "description": "Returns a paginated list of `BreakType` instances for a business." }, "response": [ { "id": "be1bbb73-f4f1-4d59-8903-c5ef6507096f", "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/labor/break-types?location_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types" ], "query": [ { "description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location.", "key": "location_id", "value": "" }, { "description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `BreakType` results to fetch.", "key": "cursor", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"break_types\": [\n {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"PAYMENT_METHOD_ERROR\",\n \"code\": \"ONE_INSTRUMENT_EXPECTED\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"INVALID_LOCATION\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-be1bbb73-f4f1-4d59-8903-c5ef6507096f" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-1bf80226-abb2-4ca5-bb91-5468543b584f" }, { "name": "Square Create Break Type", "id": "57342d0f-38ba-4b38-839b-4dbfdb9d656d", "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 \"break_type\": {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/break-types", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types" ] }, "description": "Creates a new `BreakType`.\n\nA `BreakType` is a template for creating `Break` objects.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `break_name`\n- `expected_duration`\n- `is_paid`\n\nYou can only have three `BreakType` instances per location. If you attempt to add a fourth\n`BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\"\nis returned." }, "response": [ { "id": "d22471b5-70ed-4f8d-90aa-059b3db91fa7", "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 \"break_type\": {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/break-types", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "break-types" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"break_type\": {\n \"location_id\": \"\",\n \"break_name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"INVALID_ACCOUNT\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"UNSUPPORTED_LOYALTY_REWARD_TIER\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-d22471b5-70ed-4f8d-90aa-059b3db91fa7" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-57342d0f-38ba-4b38-839b-4dbfdb9d656d" } ], "id": "1a9b1f96-2308-4fa1-bed2-b62901e09209", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-1a9b1f96-2308-4fa1-bed2-b62901e09209" }, { "name": "employee-wages", "item": [ { "name": "{id}", "item": [ { "name": "Square Get Employee Wage", "id": "ebd21296-991b-4a16-9236-4678d3397266", "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/labor/employee-wages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "employee-wages", ":id" ], "variable": [ { "id": "37f451fa-31b9-4e3e-9cb8-9309cfe5e288", "key": "id", "value": "", "description": "(Required) The UUID for the `EmployeeWage` being retrieved." } ] }, "description": "Returns a single `EmployeeWage` specified by `id`." }, "response": [ { "id": "e9d9327c-5a55-4d7e-823b-eda8257e33ce", "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/labor/employee-wages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "employee-wages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"employee_wage\": {\n \"id\": \"\",\n \"employee_id\": \"\",\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"CLP\"\n }\n },\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"MERCHANT_SUBSCRIPTION_NOT_FOUND\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"VALUE_TOO_SHORT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-e9d9327c-5a55-4d7e-823b-eda8257e33ce" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-ebd21296-991b-4a16-9236-4678d3397266" } ], "id": "6fd32ffc-fff6-4ea0-b60c-dd770788a17e", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-6fd32ffc-fff6-4ea0-b60c-dd770788a17e" }, { "name": "Square List Employee Wages", "id": "489eae1e-412b-426f-8d68-f5a4411a19d1", "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/labor/employee-wages?employee_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "employee-wages" ], "query": [ { "description": "Filter the returned wages to only those that are associated with the specified employee.", "key": "employee_id", "value": "" }, { "description": "The maximum number of `EmployeeWage` results to return per page. The number can range between\n1 and 200. The default is 200.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `EmployeeWage` results to fetch.", "key": "cursor", "value": "" } ] }, "description": "Returns a paginated list of `EmployeeWage` instances for a business." }, "response": [ { "id": "c3923af9-92b0-4b20-bb82-2650db419c6f", "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/labor/employee-wages?employee_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "employee-wages" ], "query": [ { "description": "Filter the returned wages to only those that are associated with the specified employee.", "key": "employee_id", "value": "" }, { "description": "The maximum number of `EmployeeWage` results to return per page. The number can range between\n1 and 200. The default is 200.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `EmployeeWage` results to fetch.", "key": "cursor", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"employee_wages\": [\n {\n \"id\": \"\",\n \"employee_id\": \"\",\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"TMT\"\n }\n },\n {\n \"id\": \"\",\n \"employee_id\": \"\",\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"SLE\"\n }\n }\n ],\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"MERCHANT_SUBSCRIPTION_ERROR\",\n \"code\": \"API_VERSION_INCOMPATIBLE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"ONE_INSTRUMENT_EXPECTED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-c3923af9-92b0-4b20-bb82-2650db419c6f" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-489eae1e-412b-426f-8d68-f5a4411a19d1" } ], "id": "f5dd9650-64cf-42b2-a8ce-8d635f3d1a43", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-f5dd9650-64cf-42b2-a8ce-8d635f3d1a43" }, { "name": "shifts", "item": [ { "name": "search", "item": [ { "name": "Square Search Shifts", "id": "a842cb02-26be-445e-831a-63dcf717cdf1", "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 \"query\": {\n \"filter\": {\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"employee_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"OPEN\",\n \"start\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"end\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"workday\": {\n \"date_range\": {\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"match_shifts_by\": \"END_AT\",\n \"default_timezone\": \"\"\n },\n \"team_member_ids\": [\n \"\",\n \"\"\n ]\n },\n \"sort\": {\n \"field\": \"UPDATED_AT\",\n \"order\": \"ASC\"\n }\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/shifts/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", "search" ] }, "description": "Returns a paginated list of `Shift` records for a business.\nThe list to be returned can be filtered by:\n- Location IDs\n- Team member IDs\n- Shift status (`OPEN` or `CLOSED`)\n- Shift start\n- Shift end\n- Workday details\n\nThe list can be sorted by:\n- `START_AT`\n- `END_AT`\n- `CREATED_AT`\n- `UPDATED_AT`" }, "response": [ { "id": "49a5a4b6-fd1c-4281-bf6b-4a1dae6c038a", "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 \"query\": {\n \"filter\": {\n \"location_ids\": [\n \"\",\n \"\"\n ],\n \"employee_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"OPEN\",\n \"start\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"end\": {\n \"start_at\": \"\",\n \"end_at\": \"\"\n },\n \"workday\": {\n \"date_range\": {\n \"start_date\": \"\",\n \"end_date\": \"\"\n },\n \"match_shifts_by\": \"END_AT\",\n \"default_timezone\": \"\"\n },\n \"team_member_ids\": [\n \"\",\n \"\"\n ]\n },\n \"sort\": {\n \"field\": \"UPDATED_AT\",\n \"order\": \"ASC\"\n }\n },\n \"limit\": \"\",\n \"cursor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/shifts/search", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", "search" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"shifts\": [\n {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"AED\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"CLOSED\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"MUR\"\n }\n }\n ],\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"VALUE_TOO_LOW\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-49a5a4b6-fd1c-4281-bf6b-4a1dae6c038a" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-a842cb02-26be-445e-831a-63dcf717cdf1" } ], "id": "d0e8db5a-299c-44ff-a64e-a8106ff0b277", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-d0e8db5a-299c-44ff-a64e-a8106ff0b277" }, { "name": "{id}", "item": [ { "name": "Square Delete Shift", "id": "19cbf23b-a1fe-4a59-b898-16d3e7df0ec4", "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/labor/shifts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", ":id" ], "variable": [ { "id": "7949cb43-a7f7-4f9a-b262-0147c917af3d", "key": "id", "value": "", "description": "(Required) The UUID for the `Shift` being deleted." } ] }, "description": "Deletes a `Shift`." }, "response": [ { "id": "c9387bcf-b8b1-42cf-b87c-801f969d8cd8", "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/labor/shifts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", ":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\": \"API_ERROR\",\n \"code\": \"INCORRECT_TYPE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"REFUND_AMOUNT_INVALID\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-c9387bcf-b8b1-42cf-b87c-801f969d8cd8" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-19cbf23b-a1fe-4a59-b898-16d3e7df0ec4" }, { "name": "Square Get Shift", "id": "54c6c773-f4ba-4365-8543-4ee3897e6daa", "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/labor/shifts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", ":id" ], "variable": [ { "id": "b904db35-c00e-4b13-80ad-eeab4af97e6d", "key": "id", "value": "", "description": "(Required) The UUID for the `Shift` being retrieved." } ] }, "description": "Returns a single `Shift` specified by `id`." }, "response": [ { "id": "419f57c6-a0a4-430e-b881-d0d40b6b723a", "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/labor/shifts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"shift\": {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"SOS\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"OPEN\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"SHP\"\n }\n },\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"UNSUPPORTED_COUNTRY\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-419f57c6-a0a4-430e-b881-d0d40b6b723a" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-54c6c773-f4ba-4365-8543-4ee3897e6daa" }, { "name": "Square Update Shift", "id": "2dd6c100-9e1c-48ff-b846-1224e1aa383e", "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 \"shift\": {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"BTC\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n },\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"CLOSED\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"MUR\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/shifts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", ":id" ], "variable": [ { "id": "9dfad692-49de-4ab7-b98e-9c6874133061", "key": "id", "value": "", "description": "(Required) The ID of the object being updated." } ] }, "description": "Updates an existing `Shift`.\n\nWhen adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have\nthe `end_at` property set to a valid RFC-3339 datetime string.\n\nWhen closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at`\nset on each `Break`." }, "response": [ { "id": "928134a7-0f3d-4457-a98f-86954904b4d1", "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 \"shift\": {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"BTC\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n },\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"CLOSED\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"MUR\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/shifts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"shift\": {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"UNKNOWN_CURRENCY\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"CLOSED\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"TND\"\n }\n },\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"TRANSACTION_LIMIT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-928134a7-0f3d-4457-a98f-86954904b4d1" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-2dd6c100-9e1c-48ff-b846-1224e1aa383e" } ], "id": "248f5173-a855-4e6d-a41d-9848f2384752", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-248f5173-a855-4e6d-a41d-9848f2384752" }, { "name": "Square Create Shift", "id": "4fc5a224-c061-463f-81f1-49d626f4503b", "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 \"shift\": {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"NAD\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n },\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"CLOSED\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"KYD\"\n }\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/shifts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts" ] }, "description": "Creates a new `Shift`.\n\nA `Shift` represents a complete workday for a single team member.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `team_member_id`\n- `start_at`\n\nAn attempt to create a new `Shift` can result in a `BAD_REQUEST` error when:\n- The `status` of the new `Shift` is `OPEN` and the team member has another\nshift with an `OPEN` status.\n- The `start_at` date is in the future.\n- The `start_at` or `end_at` date overlaps another shift for the same team member.\n- The `Break` instances are set in the request and a break `start_at`\nis before the `Shift.start_at`, a break `end_at` is after\nthe `Shift.end_at`, or both." }, "response": [ { "id": "faef3db3-4290-4a80-82f6-729fe6e20e88", "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 \"shift\": {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"NAD\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n },\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"CLOSED\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"KYD\"\n }\n },\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/shifts", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "shifts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"shift\": {\n \"location_id\": \"\",\n \"start_at\": \"\",\n \"id\": \"\",\n \"employee_id\": \"\",\n \"timezone\": \"\",\n \"end_at\": \"\",\n \"wage\": {\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"IRR\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"breaks\": [\n {\n \"start_at\": \"\",\n \"break_type_id\": \"\",\n \"name\": \"\",\n \"expected_duration\": \"\",\n \"is_paid\": \"\",\n \"id\": \"\",\n \"end_at\": \"\"\n }\n ],\n \"status\": \"CLOSED\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"team_member_id\": \"\",\n \"declared_cash_tip_money\": {\n \"amount\": \"\",\n \"currency\": \"MRO\"\n }\n },\n \"errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"MISSING_ACCOUNT_TYPE\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-faef3db3-4290-4a80-82f6-729fe6e20e88" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-4fc5a224-c061-463f-81f1-49d626f4503b" } ], "id": "469a3971-93c4-499f-bcf4-f10069f01add", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-469a3971-93c4-499f-bcf4-f10069f01add" }, { "name": "team-member-wages", "item": [ { "name": "{id}", "item": [ { "name": "Square Get Team Member Wage", "id": "76065bb9-a3ac-4148-a1e8-e9c7e7975f21", "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/labor/team-member-wages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "team-member-wages", ":id" ], "variable": [ { "id": "ca87ac33-97fb-4c2c-97f2-b7bcb87cc6e5", "key": "id", "value": "", "description": "(Required) The UUID for the `TeamMemberWage` being retrieved." } ] }, "description": "Returns a single `TeamMemberWage` specified by `id`." }, "response": [ { "id": "fb1f67e4-a1f1-47ec-9c2d-c94a4157e8ff", "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/labor/team-member-wages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "team-member-wages", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"team_member_wage\": {\n \"id\": \"\",\n \"team_member_id\": \"\",\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"SOS\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"EXPECTED_JSON_BODY\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"EXTERNAL_VENDOR_ERROR\",\n \"code\": \"PAYMENT_LIMIT_EXCEEDED\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-fb1f67e4-a1f1-47ec-9c2d-c94a4157e8ff" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-76065bb9-a3ac-4148-a1e8-e9c7e7975f21" } ], "id": "25bd1293-bf13-461e-aa34-8d90cbb19638", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-25bd1293-bf13-461e-aa34-8d90cbb19638" }, { "name": "Square List Team Member Wages", "id": "ea6c52f5-5add-4fab-947e-42ed1c52e5a4", "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/labor/team-member-wages?team_member_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "team-member-wages" ], "query": [ { "description": "Filter the returned wages to only those that are associated with the\nspecified team member.", "key": "team_member_id", "value": "" }, { "description": "The maximum number of `TeamMemberWage` results to return per page. The number can range between\n1 and 200. The default is 200.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `EmployeeWage` results to fetch.", "key": "cursor", "value": "" } ] }, "description": "Returns a paginated list of `TeamMemberWage` instances for a business." }, "response": [ { "id": "97892580-db73-4cdc-8a92-2113a4642592", "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/labor/team-member-wages?team_member_id=&limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "team-member-wages" ], "query": [ { "description": "Filter the returned wages to only those that are associated with the\nspecified team member.", "key": "team_member_id", "value": "" }, { "description": "The maximum number of `TeamMemberWage` results to return per page. The number can range between\n1 and 200. The default is 200.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `EmployeeWage` results to fetch.", "key": "cursor", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"team_member_wages\": [\n {\n \"id\": \"\",\n \"team_member_id\": \"\",\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"HUF\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n },\n {\n \"id\": \"\",\n \"team_member_id\": \"\",\n \"title\": \"\",\n \"hourly_rate\": {\n \"amount\": \"\",\n \"currency\": \"NOK\"\n },\n \"job_id\": \"\",\n \"tip_eligible\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"MERCHANT_SUBSCRIPTION_NOT_FOUND\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"EXPECTED_MAP\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-97892580-db73-4cdc-8a92-2113a4642592" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-ea6c52f5-5add-4fab-947e-42ed1c52e5a4" } ], "id": "a2f1b0dc-bef8-42a0-bc2f-9f0151762703", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-a2f1b0dc-bef8-42a0-bc2f-9f0151762703" }, { "name": "workweek-configs", "item": [ { "name": "{id}", "item": [ { "name": "Square Update Workweek Config", "id": "c576cd90-d355-4b8c-9866-0b06452509c3", "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 \"workweek_config\": {\n \"start_of_week\": \"WED\",\n \"start_of_day_local_time\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/workweek-configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "workweek-configs", ":id" ], "variable": [ { "id": "52f9d877-ef89-4cb9-9e14-4bf5883dfe9f", "key": "id", "value": "", "description": "(Required) The UUID for the `WorkweekConfig` object being updated." } ] }, "description": "Updates a `WorkweekConfig`." }, "response": [ { "id": "a31a34b3-adb2-4abf-9c1f-7e269ab9bb96", "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 \"workweek_config\": {\n \"start_of_week\": \"WED\",\n \"start_of_day_local_time\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/labor/workweek-configs/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "workweek-configs", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"workweek_config\": {\n \"start_of_week\": \"WED\",\n \"start_of_day_local_time\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"ACCOUNT_UNUSABLE\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"TRANSACTION_LIMIT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-a31a34b3-adb2-4abf-9c1f-7e269ab9bb96" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-c576cd90-d355-4b8c-9866-0b06452509c3" } ], "id": "95614874-64bc-4335-a271-ddef9bd193bd", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-95614874-64bc-4335-a271-ddef9bd193bd" }, { "name": "Square List Workweek Configs", "id": "7e18d4f6-77df-49df-9694-8ead6ef0bcde", "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/labor/workweek-configs?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "workweek-configs" ], "query": [ { "description": "The maximum number of `WorkweekConfigs` results to return per page.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `WorkweekConfig` results to fetch.", "key": "cursor", "value": "" } ] }, "description": "Returns a list of `WorkweekConfig` instances for a business." }, "response": [ { "id": "38e7b62d-648b-4ac8-a6ed-9f8a21d9948c", "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/labor/workweek-configs?limit=&cursor=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "labor", "workweek-configs" ], "query": [ { "description": "The maximum number of `WorkweekConfigs` results to return per page.", "key": "limit", "value": "" }, { "description": "A pointer to the next page of `WorkweekConfig` results to fetch.", "key": "cursor", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"workweek_configs\": [\n {\n \"start_of_week\": \"SUN\",\n \"start_of_day_local_time\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"start_of_week\": \"SUN\",\n \"start_of_day_local_time\": \"\",\n \"id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"cursor\": \"\",\n \"errors\": [\n {\n \"category\": \"REFUND_ERROR\",\n \"code\": \"MISSING_PIN\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"GIFT_CARD_AVAILABLE_AMOUNT\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-38e7b62d-648b-4ac8-a6ed-9f8a21d9948c" } ], "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-7e18d4f6-77df-49df-9694-8ead6ef0bcde" } ], "id": "c21c00b0-9d30-4ab4-9282-4d86fb32633e", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-c21c00b0-9d30-4ab4-9282-4d86fb32633e" } ], "id": "7303281b-04d7-4cab-a385-eef48e5107f1", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-7303281b-04d7-4cab-a385-eef48e5107f1" } ], "id": "eacfd129-8e74-49a7-8e52-a09706a63c93", "createdAt": "2026-07-28T03:03:58.000Z", "updatedAt": "2026-07-28T03:03:58.000Z", "uid": "35240-eacfd129-8e74-49a7-8e52-a09706a63c93" } ], "variable": [ { "key": "baseUrl", "value": "https://connect.squareup.com" } ] }