Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
V1Employees

ListEmployees

Provides summary information for all of a business's employees.

get/v1/me/employees

Query parameters

orderstring

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

begin_updated_atstring

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

end_updated_atstring

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

begin_created_atstring

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

end_created_atstring

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

statusstring

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

external_idstring

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

limitinteger

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

batch_tokenstring

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

Response

Success

authorized_location_idsstring[]

The IDs of the locations the employee is allowed to clock in at.

created_atstring

The time when the employee entity was created, in ISO 8601 format.

emailstring

The employee's email address.

external_idstring

An ID the merchant can set to associate the employee with an entity in another system.

first_namestring required

The employee's first name.

idstring

The employee's unique ID.

last_namestring required

The employee's last name.

role_idsstring[]

The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.

statusstring

Whether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard.

updated_atstring

The time when the employee entity was most recently updated, in ISO 8601 format.