• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List employees

Deprecated
Effective August 26th, 2020
Permissions
EMPLOYEES_READ

Deprecation date
2020-08-26
Retirement date
2021-08-26
Replaced by
SearchTeamMembers
Migration guide
Name Description
location_id
string
status
string

Specifies the EmployeeStatus to filter the employee by.

limit
integer (32-bit)

The number of employees to be returned on each page.

cursor
string

The token required to retrieve the specified page of results.

Response Fields

Name Description
employees
Employee [ ]
cursor
string

The token to be used to retrieve the next page of results.

errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
GET /v2/employees
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/employees \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'