You are viewing an old version of the API
List employees
V1

Note We recommend using the Square API (V2) for all new development when possible.

Provides summary information for all of a business's employees

Required permissions EMPLOYEES_READ

Query Parameters

Name Description
order
string

The order in which employees are listed in the response, based on their created_at field. Default value: ASC

begin_updated_at
string

If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format

end_updated_at
string

If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.

begin_created_at
string

If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.

end_created_at
string

If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.

status
string

If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).

external_id
string

If provided, the endpoint returns only employee entities with the specified external_id.

limit
integer

The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.

batch_token
string

A pagination cursor to retrieve the next set of results for your original query to the endpoint.

Response Fields

Name Description
{items}
V1​Employee [ ]

Root array of on V1Employee objects on the response

Examples

You are viewing an old version of the API
GET /v1/me/employees
cURL
  • cURL
curl https://connect.squareup.com/v1/me/employees \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Share Feedback

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