v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB

V1Employees

CreateEmployee

Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with the Connect API have an initial status of INACTIVE. Inactive employees cannot sign in to Square Point of Sale until they are activated from the Square Dashboard. Employee status cannot be changed with the Connect API.

Employee entities cannot be deleted. To disable employee profiles, set the employee's status to <code>INACTIVE</code>

post/v1/me/employees

Request body

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.

Response

Success