List employees
Required permissions:
EMPLOYEES_READ
Query Parameters
| Name | Description |
|---|---|
location_id
|
Filter employees returned to only those that are associated with the specified location. |
status
|
Specifies the EmployeeStatus to filter the employee by. |
limit
|
The number of employees to be returned on each page. |
cursor
|
The token required to retrieve the specified page of results. |
Response Fields
| Name | Description |
|---|---|
employees
|
List of employees returned from the request. |
cursor
|
The token to be used to retrieve the next page of results. |
errors
|
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
curl https://connect.squareup.com/v2/employees \
-H 'Square-Version: 2020-06-25' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'