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

Create and maintain service appointments.

Cards

Provides endpoints to access a payment card stored on file.

Cash Drawer Shifts

Get details about cash drawer shifts.

Catalog

Sync items to Square Point of Sale to itemize payments consistently across all channels.

Checkout

Accept itemized payments on a Square-hosted web page. No frontend experience required.

Customers

Create and manage customer profiles and sync customer relationship management (CRM) systems with Square.

Customer Groups

Manage customers by groups.

Customer Segments

Manage customers by segments.

Devices

Use the Devices API to configure a Square Terminal.

Disputes

Use the Disputes API to manage disputes (chargebacks).

Employees

Provides a query endpoint to get a list of the employees for a seller.

Gift Cards

Provides endpoints to create and manage gift cards.

Gift Card Activities

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

Keep an inventory of catalog items in sync across all commerce channels.

Invoices

Use the Invoices API to manage invoices.

Labor

Manage shifts, breaks, and wages for employees in Square Point of Sale.

Locations

Get a list of a seller's locations.

Loyalty

Provides endpoints to access the buyer loyalty program, create and manage loyalty accounts, and create and manage loyalty rewards.

Merchants

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

Mobile Authorization

Provides an endpoint for getting a mobile authorization code for use in Reader SDK applications.

Orders

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

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.