You are viewing an old version of the API
List employees

Required permissions EMPLOYEES_READ

Query Parameters

Name Description
location_id
string

Filter employees returned to only those that are associated with the specified location.

status
string

Specifies the EmployeeStatus to filter the employee by.

limit
integer

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
cursor
string

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

employees
Employee [ ]

List of employees returned from the request.

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
curl https://connect.squareup.com/v2/employees \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?