OAuthPermission

HTTP Method: GET

Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint.

HTTP Method: GET

Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint.

HTTP Method: GET

Grants read access to customer information. For example, to call the ListCustomers endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to customer information. For example, to create and update customer profiles.

HTTP Method: POST, GET

Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint.

HTTP Method: GET

Grants read access to employee profile information. For example, to call the Connect v1 Employees API.

HTTP Method: POST, PUT, DELETE

Grants write access to employee profile information. For example, to create and modify employee profiles.

HTTP Method: GET

Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint.

HTTP Method: GET

Grants read access to product catalog information. For example, to obtain objects in a product catalog.

HTTP Method: POST, PUT, DELETE

Grants write access to product catalog information. For example, to modify or add to a product catalog.

HTTP Method: GET

Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint.

HTTP Method: GET

Grants read access to business and location information. For example, to obtain a location ID for subsequent activity.

HTTP Method: GET

Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to order information. For example, to call the CreateCheckout endpoint.

HTTP Method: GET

Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API.

HTTP Method: POST, PUT, DELETE

Allow third party applications to deduct a portion of each transaction amount. Required to use multiparty transaction functionality with the Payments API.

HTTP Method: POST, PUT, DELETE

Grants write access to payments and refunds information. For example, to process in-person payments.

HTTP Method: GET

Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint.

HTTP Method: GET

Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to employee shift information. For example, to create and modify employee shifts.

HTTP Method: GET

Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint.

HTTP Method: GET, POST

Grants read access to booking information. For example, to call the RetrieveBooking endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to booking information. For example, to call the CreateBooking endpoint.

HTTP Method: GET

Grants read access to booking business settings. For example, to call the ListTeamMemberBookingProfiles endpoint.

HTTP Method: GET, POST

Grants read access to invoice information. For example, to call the ListInvoices endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to invoice information. For example, to call the CreateInvoice endpoint.

HTTP Method: GET, POST

Grants read access to subscription information. For example, to call the RetrieveSubscription endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to subscription information. For example, to call the CreateSubscription endpoint.

HTTP Method: GET

Grants read access to dispute information. For example, to call the RetrieveDispute endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to dispute information. For example, to call the SubmitEvidence endpoint.

HTTP Method: GET, POST

Grants read access to gift card information. For example, to call the RetrieveGiftCard endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to gift card information. For example, to call the CreateGiftCard endpoint.

HTTP Method: POST, PUT, DELETE

Write access to ECOM online store snippets on published websites.

HTTP Method: GET, POST

Read access to ECOM online store snippets on published websites.

HTTP Method: GET, POST

Read access to ECOM online store site details.

HTTP Method: POST, PUT, DELETE

Allows the developer to process payments on behalf of a seller using a shared on file payment method.

HTTP Method: GET, POST

Grants read access to all of a seller's booking information, calendar, and business details. This permission must be accompanied by the APPOINTMENTS_READ permission.

HTTP Method: POST, PUT, DELETE

Grants write access to all booking details, including double-booking a seller. This permission must be accompanied by the APPOINTMENTS_WRITE permission.

HTTP Method: POST, PUT

Grants write access to business and location information. For example, to create a new location or update the business hours at an existing location.

HTTP Method: GET, POST

Grants read access to vendor information, for example, when calling the RetrieveVendor endpoint.

HTTP Method: POST, PUT, DELETE

Grants write access to vendor information, for example, when calling the BulkUpdateVendors endpoint.

HTTP Method: GET

Grants read access to payouts and payout entries information. For example, to call the Connect v2 ListPayouts endpoint.