employee.md

Employee

An employee object that is used by the external API.

Structure

Employee

Fields

Name	Type	Tags	Description
id	string | undefined	Optional	UUID for this object.
firstName	string | undefined	Optional	The employee's first name.
lastName	string | undefined	Optional	The employee's last name.
email	string | undefined	Optional	The employee's email address
phoneNumber	string | undefined	Optional	The employee's phone number in E.164 format, i.e. "+12125554250"
locationIds	string[] | undefined	Optional	A list of location IDs where this employee has access to.
status	string | undefined	Optional	The status of the Employee being retrieved.
isOwner	boolean | undefined	Optional	Whether this employee is the owner of the merchant. Each merchant has one owner employee, and that employee has full authority over the account.
createdAt	string | undefined	Optional	A read-only timestamp in RFC 3339 format.
updatedAt	string | undefined	Optional	A read-only timestamp in RFC 3339 format.

Example (as JSON)

{
  "id": null,
  "first_name": null,
  "last_name": null,
  "email": null,
  "phone_number": null,
  "location_ids": null,
  "status": null,
  "is_owner": null
}