Reference for all OAuth permissions (scopes) needed to call Square API endpoints with an OAuth access token.
OAuth API

OAuth Permissions Reference

To get a scoped OAuth access token used in calling a Square API endpoint, you need to specify the permissions that your application needs to access Square account resources. The permissions you specify are shown to the user in an authorization dialog box that lets the user grant access to your application.

The following sections list and describe all the Square API services, their endpoints, and the OAuth scopes (permissions) needed to access them.

Bank Accounts Permalink Get a link to this section

The Bank Accounts API lets developers retrieve information about the bank accounts linked to a Square account.

API
Permission
GetBankAccountBANK_ACCOUNTS_READ
ListBankAccountsBANK_ACCOUNTS_READ
GetBankAccountByV1IdBANK_ACCOUNTS_READ

Bookings Permalink Get a link to this section

The Bookings API creates and maintains service appointments.

API
Permission
CreateBooking
 •    APPOINTMENTS_WRITE (buyer-level).
 •    APPOINTMENTS_WRITE, APPOINTMENTS_ALL_WRITE (seller-level).
SearchAvailability
 •    APPOINTMENTS_READ (buyer-level).
 •    APPOINTMENTS_READ, APPOINTMENTS_ALL_READ (seller-level).
RetrieveBusinessBookingProfileAPPOINTMENTS_BUSINESS_SETTINGS_READ
ListTeamMemberBookingProfilesAPPOINTMENTS_BUSINESS_SETTINGS_READ
RetrieveTeamMemberBookingProfileAPPOINTMENTS_BUSINESS_SETTINGS_READ
ListBookings
 •    APPOINTMENTS_READ (buyer-level).
 •    APPOINTMENTS_READ, APPOINTMENTS_ALL_READ (seller-level).
RetrieveBooking
 •    APPOINTMENTS_READ (buyer-level).
 •    APPOINTMENTS_READ, APPOINTMENTS_ALL_READ (seller-level).
UpdateBooking
 •    APPOINTMENTS_WRITE(buyer-level).
 •    APPOINTMENTS_WRITE, APPOINTMENTS_ALL_WRITE (seller-level).
CancelBooking
 •    APPOINTMENTS_WRITE (buyer-level).
 •    APPOINTMENTS_WRITE, APPOINTMENTS_ALL_WRITE (seller-level).

Cards Permalink Get a link to this section

The Cards API provides endpoints to access a payment card stored on file.

API
Permissions
ListCardsPAYMENTS_READ
CreateCardPAYMENTS_WRITE
RetrieveCardPAYMENTS_READ
DisableCardPAYMENTS_WRITE

Cash Drawer Shifts Permalink Get a link to this section

The Cash Drawer Shifts API provides details about cash drawer shifts.

API
Permission
ListCashDrawerShiftsCASH_DRAWER_READ
ListCashDrawerShiftEventsCASH_DRAWER_READ
RetrieveCashDrawerShiftCASH_DRAWER_READ

Catalog Permalink Get a link to this section

The Catalog API syncs items to Square Point of Sale in order to itemize payments consistently across all channels.

API
Permission
BatchDeleteCatalogObjectsITEMS_WRITE
BatchUpsertCatalogObjectsITEMS_WRITE
BatchRetrieveCatalogObjectsITEMS_READ
CatalogInfoITEMS_READ
CreateCatalogImageITEMS_WRITE
DeleteCatalogObjectITEMS_WRITE
ListCatalogITEMS_READ
RetrieveCatalogObjectITEMS_READ
SearchCatalogItemsITEMS_READ
SearchCatalogObjectsITEMS_READ
UpdateItemTaxesITEMS_WRITE
UpdateItemModifierListsITEMS_WRITE
UpsertCatalogObjectITEMS_WRITE

Checkout Permalink Get a link to this section

The Checkout API accepts itemized payments on a Square-hosted web page. No frontend experience required.

API
Permission
CreateCheckoutORDERS_WRITE
PAYMENTS_WRITE
PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS

Customers Permalink Get a link to this section

The Customers API creates and manages customer profiles and syncs customer relationship management (CRM) systems with Square.

API
Permission
AddGroupToCustomerCUSTOMERS_WRITE
CreateCustomerCUSTOMERS_WRITE
CreateCustomerCard (deprecated)CUSTOMERS_WRITE
DeleteCustomerCUSTOMERS_WRITE
DeleteCustomerCard (deprecated)CUSTOMERS_WRITE
ListCustomersCUSTOMERS_READ
RemoveGroupFromCustomerCUSTOMERS_WRITE
RetrieveCustomerCUSTOMERS_READ
SearchCustomersCUSTOMERS_READ
UpdateCustomerCUSTOMERS_WRITE

Customer Groups Permalink Get a link to this section

The Customer Groups API manages customers by groups.

API
Permission
CreateCustomerGroupCUSTOMERS_WRITE
DeleteCustomerGroupCUSTOMERS_WRITE
ListCustomerGroupsCUSTOMERS_READ
RetrieveCustomerGroupCUSTOMERS_READ
UpdateCustomerGroupCUSTOMERS_WRITE

Customer Segments Permalink Get a link to this section

The Customer Segments API manages customers by segments.

API
Permission
ListCustomerSegmentsCUSTOMERS_READ
RetrieveCustomerSegmentCUSTOMERS_READ

Devices Permalink Get a link to this section

Use the Devices API to configure a Square Terminal.

API
Permission
CreateDeviceCodeDEVICE_CREDENTIAL_MANAGEMENT
GetDeviceCodeDEVICE_CREDENTIAL_MANAGEMENT
ListDeviceCodesDEVICE_CREDENTIAL_MANAGEMENT

Disputes Permalink Get a link to this section

Use the Disputes API to manage disputes (chargebacks).

API
Permission
AcceptDisputeDISPUTES_WRITE
CreateDisputeEvidenceFileDISPUTES_WRITE
CreateDisputeEvidenceTextDISPUTES_WRITE
ListDisputeEvidenceDISPUTES_READ
ListDisputesDISPUTES_READ
DeleteDisputeEvidenceDISPUTES_WRITE
RetrieveDisputeDISPUTES_READ
RetrieveDisputeEvidenceDISPUTES_READ
SubmitEvidenceDISPUTES_WRITE

Employees Permalink Get a link to this section

The Employees API provides a query endpoint to get a list of the employees for a seller.

API
Permission
ListEmployeesEMPLOYEES_READ
RetrieveEmployeeEMPLOYEES_READ

Gift Cards Permalink Get a link to this section

The Gift Cards API provides endpoints to create and manage gift cards.

API
Permission
ListGiftCardsGIFTCARDS_READ
CreateGiftCardGIFTCARDS_WRITE
RetrieveGiftCardFromGANGIFTCARDS_READ
RetrieveGiftCardFromNonceGIFTCARDS_READ
LinkCustomerToGiftCardGIFTCARDS_WRITE
UnlinkCustomerFromGiftCardGIFTCARDS_WRITE
RetrieveGiftCardGIFTCARDS_READ

Gift Card Activities Permalink Get a link to this section

The Gift Card Activities API provides endpoints to create gift card activities, such as activate a gift card, add funds to a gift card, and redeem a gift card.

API
Permission
ListGiftCardActivitiesGIFTCARDS_READ
CreateGiftCardActivityGIFTCARDS_WRITE

Inventory Permalink Get a link to this section

The Inventory API keeps an inventory of catalog items in sync across all commerce channels.

API
Permission
BatchChangeInventoryINVENTORY_WRITE
BatchRetrieveInventoryCountsINVENTORY_READ
BatchRetrieveInventoryChangesINVENTORY_READ
RetrieveInventoryAdjustmentINVENTORY_READ
RetrieveInventoryChangesINVENTORY_READ
RetrieveInventoryCountINVENTORY_READ
RetrieveInventoryPhysicalCountINVENTORY_READ

Invoices Permalink Get a link to this section

Use the Invoices API to manage invoices.

API
Permissions
ListInvoicesINVOICES_READ
CreateInvoiceORDERS_WRITE
INVOICES_WRITE
SearchInvoicesINVOICES_READ
DeleteInvoiceORDERS_WRITE
INVOICES_WRITE
GetInvoiceINVOICES_READ
UpdateInvoiceORDERS_WRITE
INVOICES_WRITE
CancelInvoiceORDERS_WRITE
INVOICES_WRITE
PublishInvoiceORDERS_WRITE
INVOICES_WRITE

Labor Permalink Get a link to this section

The Labor API manages shifts, breaks, and wages for employees in Square Point of Sale.

API
Permission
CreateBreakTypeTIMECARDS_SETTINGS_WRITE
CreateShiftTIMECARDS_WRITE
DeleteBreakTypeTIMECARDS_SETTINGS_WRITE
DeleteShiftTIMECARDS_WRITE
GetBreakTypeTIMECARDS_SETTINGS_READ
GetTeamMemberWageEMPLOYEES_READ
GetShiftTIMECARDS_READ
ListBreakTypesTIMECARDS_SETTINGS_READ
ListTeamMemberWagesEMPLOYEES_READ
ListWorkweekConfigsTIMECARDS_SETTINGS_READ
SearchShiftsTIMECARDS_READ
UpdateShiftTIMECARDS_WRITE
TIMECARDS_READ
UpdateWorkweekConfigTIMECARDS_SETTINGS_READ
TIMECARDS_SETTINGS_WRITE
UpdateBreakTypeTIMECARDS_SETTINGS_READ
TIMECARDS_SETTINGS_WRITE

Locations Permalink Get a link to this section

The Locations API gets a list of a seller's locations.

API
Permission
CreateLocationMERCHANT_PROFILE_WRITE
ListLocationsMERCHANT_PROFILE_READ
RetrieveLocationMERCHANT_PROFILE_READ
UpdateLocationMERCHANT_PROFILE_WRITE

Loyalty Permalink Get a link to this section

The Loyalty API provides endpoints to access the buyer loyalty program, creates and manages loyalty accounts, and creates and manages loyalty rewards.

API
Permission
AccumulateLoyaltyPointsLOYALTY_WRITE
AdjustLoyaltyPointsLOYALTY_WRITE
CalculateLoyaltyPointsLOYALTY_READ
CreateLoyaltyAccountLOYALTY_WRITE
CreateLoyaltyRewardLOYALTY_WRITE
DeleteLoyaltyRewardLOYALTY_WRITE
RetrieveLoyaltyProgramLOYALTY_READ
ListLoyaltyPrograms (deprecated)LOYALTY_READ
RedeemLoyaltyRewardLOYALTY_WRITE
RetrieveLoyaltyAccountLOYALTY_READ
RetrieveLoyaltyRewardLOYALTY_READ
SearchLoyaltyAccountsLOYALTY_READ
SearchLoyaltyEventsLOYALTY_READ
SearchLoyaltyRewardsLOYALTY_READ

Merchants Permalink Get a link to this section

Use the Merchants API to retrieve information about a Square merchant account.

API
Permission
ListMerchantsMERCHANT_PROFILE_READ
RetrieveMerchantMERCHANT_PROFILE_READ

Mobile Authorization Permalink Get a link to this section

The Mobile Authorization API provides an endpoint for getting a mobile authorization code for use in Reader SDK applications.

API
Permission
CreateMobileAuthorizationCodePAYMENTS_WRITE_IN_PERSON

Orders Permalink Get a link to this section

The Orders API gets sales data for a Square seller, itemize payments, push orders to Point of Sale, and more.

API
Permission
CalculateOrderN/A
CloneOrderORDERS_WRITE
CreateOrderORDERS_WRITE
BatchRetrieveOrdersORDERS_READ
PayOrderORDERS_WRITE
PAYMENTS_WRITE
RetrieveOrderORDERS_WRITE
ORDERS_READ
SearchOrdersORDERS_READ
UpdateOrderORDERS_WRITE

Payments and Refunds Permalink Get a link to this section

The Payments API lets developers take and manage payments.

API
Permission
CancelPaymentPAYMENTS_WRITE
CancelPaymentByIdempotencyKeyPAYMENTS_WRITE
CompletePaymentPAYMENTS_WRITE
CreatePaymentPAYMENTS_WRITE
PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS
GetPaymentPAYMENTS_READ
GetPaymentRefundPAYMENTS_READ
ListPaymentsPAYMENTS_READ
ListPaymentRefundsPAYMENTS_READ
RefundPaymentPAYMENTS_WRITE
PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS

Payouts Permalink Get a link to this section

Use the Payouts API to see a list of deposits and withdrawals from a seller’s external bank account, a Square checking or savings account (available only in the United States), or a debit card (for instant transfers).

API
Permission
ListPayoutsPAYOUTS_READ
GetPayoutPAYOUTS_READ
ListPayoutEntriesPAYOUTS_READ

Sites Permalink Get a link to this section

Use the Sites API to list the Square Online sites for a seller account.

API
Permissions
ListSitesONLINE_STORE_SITE_READ

Snippets Permalink Get a link to this section

Use the Snippets API to manage snippets on Square Online sites.

API
Permissions
UpsertSnippetONLINE_STORE_SNIPPETS_WRITE
RetrieveSnippetONLINE_STORE_SNIPPETS_READ
DeleteSnippetONLINE_STORE_SNIPPETS_WRITE

Subscriptions Permalink Get a link to this section

Use the Subscriptions API to manage subscriptions. For more information about required permissions to create and update subscriptions, see Requirements and limitations.

API
Permissions
CreateSubscriptionCUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
SearchSubscriptionsSUBSCRIPTIONS_READ
RetrieveSubscriptionSUBSCRIPTIONS_READ
UpdateSubscriptionCUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
CancelSubscriptionSUBSCRIPTIONS_WRITE
ListSubscriptionEventsSUBSCRIPTIONS_READ
ResumeSubscriptionCUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
PauseSubscriptionCUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
SwapPlanCUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
DeleteSubscriptionActionSUBSCRIPTIONS_WRITE

Team Permalink Get a link to this section

The Team API lets developers manage team members and integrate Square with a third-party payroll system.

API
Permission
BulkCreateTeamMembersEMPLOYEES_WRITE
BulkUpdateTeamMembersEMPLOYEES_WRITE
CreateTeamMemberEMPLOYEES_WRITE
UpdateTeamMemberEMPLOYEES_WRITE
RetrieveTeamMemberEMPLOYEES_READ
RetrieveWageSettingEMPLOYEES_READ
SearchTeamMembersEMPLOYEES_READ
UpdateWageSettingEMPLOYEES_WRITE

Terminal Permalink Get a link to this section

The Terminal API lets developers request Square Terminal checkouts and process Interac refunds.

API
Permission
CreateTerminalCheckoutPAYMENTS_WRITE
CancelTerminalCheckoutPAYMENTS_WRITE
GetTerminalCheckoutPAYMENTS_READ
SearchTerminalCheckoutsPAYMENTS_READ
CreateTerminalRefundPAYMENTS_WRITE
CancelTerminalRefundPAYMENTS_WRITE
GetTerminalRefundPAYMENTS_READ
SearchTerminalRefundsPAYMENTS_READ
CreateTerminalActionPAYMENTS_WRITE
CancelTerminalActionPAYMENTS_WRITE
GetTerminalActionPAYMENTS_READ
CUSTOMERS_READ
SearchTerminalActionPAYMENTS_READ

Vendors Permalink Get a link to this section

The Vendors API supports managing a seller's suppliers in an application.

API
Permission
BulkCreateVendorsVENDOR_WRITE
BulkRetrieveVendorsVENDOR_READ
BulkUpdateVendorsVENDOR_WRITE
CreateVendorVENDOR_WRITE
SearchVendorsVENDOR_READ
RetrieveVendorVENDOR_READ
UpdateVendorsVENDOR_WRITE

If you need more assistance, contact Developer Support or ask for help in the Developer Forums.