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.

Link to section

Bank Accounts

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

Link to section

Bookings

The Bookings API creates and maintains service appointments.

Link to section

Booking Custom Attributes

The Booking Custom Attributes API lets you create and manage custom attributes for bookings.

Link to section

Cards

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

Link to section

Cash Drawer Shifts

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

Link to section

Catalog

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

Link to section

Checkout

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

Link to section

Customers

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

Link to section

Customer Custom Attributes

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

Link to section

Customer Groups

The Customer Groups API manages customers by groups.

Link to section

Customer Segments

The Customer Segments API manages customers by segments.

Link to section

Devices

Use the Devices API to configure a Square Terminal.

Link to section

Disputes

Use the Disputes API to manage disputes (chargebacks).

Link to section

Employees

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

Link to section

Gift Cards

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

Link to section

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.

Link to section

Inventory

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

Link to section

Invoices

Use the Invoices API to manage invoices.

Link to section

Labor

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

Link to section

Locations

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

Link to section

Location Custom Attributes

The Location Custom Attributes API lets you create and manage custom attributes for locations.

Link to section

Loyalty

The Loyalty API provides endpoints to work with loyalty programs, loyalty promotions, loyalty accounts, loyalty points, loyalty rewards, and loyalty events.

Link to section

Merchants

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

Link to section

Merchant Custom Attributes

The Merchant Custom Attributes API lets you create and manage custom attributes for merchants.

Link to section

Mobile Authorization

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

Link to section

Orders

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

Link to section

Order Custom Attributes

The Order Custom Attributes API lets you create and manage custom attributes for orders.

Link to section

Payments and Refunds

The Payments API lets developers take and manage payments. The Refunds API lets developers refund payments.

Link to section

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

Link to section

Sites

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

Link to section

Snippets

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

Link to section

Subscriptions

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

Link to section

Team

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

Link to section

Terminal

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

Link to section

Vendors

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