Object Index
You are viewing an old version of the API
Employee
V1
Square V1 APIs
We recommend using the Square API (V2) for all new development when possible. See
When to use Connect V1
to learn more about working with V1 endpoints.
Object Index
We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.
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. |
role_ids
|
The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee. |
authorized_location_ids
|
The IDs of the locations the employee is allowed to clock in at. |
email
|
The employee's email address. |
status
|
CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. |
external_id
|
An ID the merchant can set to associate the employee with an entity in another system. |
created_at
|
The time when the employee entity was created, in ISO 8601 format. |
updated_at
|
The time when the employee entity was most recently updated, in ISO 8601 format. |