Object Index
/ Definition
You are viewing an old version of the API
Employee
V1
Object Index / Definition
Note We recommend using the Square API (V2) for all new development when possible.
Represents one of a business's employees
Properties
| Name | Description |
|---|---|
id
|
The employee's unique ID. |
first_name
Required
|
The employee's first name. |
last_name
Required
|
The employee's last name. |
authorized_location_ids
|
The IDs of the locations the employee is allowed to clock in at. |
created_at
|
The time when the employee entity was created, in ISO 8601 format. |
email
|
The employee's email address. |
external_id
|
An ID the merchant can set to associate the employee with an entity in another system. |
role_ids
|
The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee. |
status
|
CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. |
updated_at
|
The time when the employee entity was most recently updated, in ISO 8601 format. |