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

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

Bookings

The Bookings API creates and maintains service appointments.

Cards

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

Cash Drawer Shifts

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

Catalog

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

Checkout

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

Customers

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

Customer Custom Attributes

The Customer Custom Attributes API lets you create and manage custom attributes for customer profiles.

Customer Groups

The Customer Groups API manages customers by groups.

Customer Segments

The Customer Segments API manages customers by segments.

Devices

Use the Devices API to configure a Square Terminal.

Disputes

Use the Disputes API to manage disputes (chargebacks).

Employees

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

Gift Cards

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

Gift Card Activities

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.

Inventory

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

Invoices

Use the Invoices API to manage invoices.

Labor

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

Locations

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

Loyalty

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

Merchants

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

Mobile Authorization

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

Orders

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

Payments and Refunds

The Payments API lets developers take and manage payments.

Payouts

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).

Sites

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

Snippets

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

Subscriptions

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

Team

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

Terminal

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

Vendors

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