Run Business with Square's Business APIs

Use Square’s back-office management APIs with custom solutions to manage locations, employees, and timecards. Connect, Square’s API suite, provides business management solutions that make it easy to run a business and control employee access to different workflows in the Square Point of Sale app.

  • Locations is a Connect v2, server-side API that returns information about business locations associated with a Square account.
  • Employees is a Connect v1, server-side API that creates and manages employee records used by the Square Point of Sale app.
  • Roles is a Connect v1, server-side API that creates and manages employee roles that grant or restrict access to the different workflows in the Square Point of Sale app.
  • Timecards is a Connect v1, server-side API that creates and manages employee shift records.

API and SDK feature comparison

Locations API (v2) Employees API (v1) Roles API (v1) Timecards API (v1)

Compatible with Square Hardware

Not Applicable

Not Applicable

Not Applicable

Not Applicable

Compatible with Square Dashboard

Included

Included

Included

Included

Development support

Desktop browsers

Not Applicable

Not Applicable

Not Applicable

Not Applicable

Mobile web browsers

Not Applicable

Not Applicable

Not Applicable

Not Applicable

Native (non-web) mobile development

Not Applicable

Not Applicable

Not Applicable

Not Applicable

Customizable UI

Not Applicable

Not Applicable

Not Applicable

Not Applicable

Test payments

Included

Not included Not included Not included
CRUD Support

CREATE

Not included

Included

Included

Included

RETRIEVE

Included

Included

Included

Included

UPDATE

Not included

Included

Included

Included

DELETE

Not included Not included Not included

Included

Security Features

HTTPS (TLS) support

Included

Included

Included

Included

OAuth support

Included

Included

Included

Included

Find the right solution

Back-Office Partner Solutions

Manage employees, permissions, and payroll with an existing open source solution.

Locations API

Look up information about business locations.

Employees API

Create and manage employee rosters.

Roles API

Manage employee permissions.

Timecards API

Create and manage employee work shifts.

FAQs

How do the API conventions in Connect v1 differ from those in Connect v2?

There are 5 key differences between Connect v1 and Connect v2.

1. Monetary amounts

In Connect v1, monetary amounts are negative if they represent money being paid out by a merchant (for example, a Square processing fee).

In Connect v2, all monetary amounts are positive.

2. Date format

In Connect v1, all dates must conform to ISO 8601 formatting requirements.

In Connect v2, all dates must conform to the stricter RFC 3339 formatting requirements.

An RFC 3339-compliant date is effectively an ISO 8601-compliant date with all the optional components provided. The one exception is fractional seconds, which can still be left out. For example, 2016-01-15T00:00:00Z is a valid ISO 8601 date and a valid RFC 3339 date, but 2016-01-15, which lacks all the required time elements, is only valid under ISO 8601 requirements.

3. Result pagination

In Connect v1, pagination information is provided in the "Link" response header.

In Connect v2, endpoints that paginate their results return a cursor field in their response body that can be used in the query string of a follow-up request to get the next set of results.

4. Default sort order

In Connect v1, endpoints that return lists of records return the results in oldest-first order by default.

In Connect v2, endpoints that return lists of records return the results in newest-first order by default.

5. Error format

In Connect v1, only one error is ever returned in a single response and the errors have a different format from v2 errors. See the Connect v1 API Reference docs for more information on Connect v1 errors.

In Connect v2, endpoints return an array of errors in the response body if an error occurred during the corresponding request. The formatting of error objects is consistent across all Connect v2 endpoints. See the Connect v2 API Reference docs for more information on Connect v2 errors.

Ask for help on Stack Overflow or join our Slack channel