Clover · Example Payload

Platform Rest Api Employee Example

RestaurantPOSPaymentsRetailSMBHardware

Platform Rest Api Employee Example is an example object payload from Clover, with 18 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idnamenicknamecustomIdemailinviteSentclaimedTimedeletedTimepinunhashedPinrolerolesisOwnershiftspaymentsordersemployeeCardsmerchant

Example Payload

Raw ↑ 
{
  "id": "9ABCDEF1234567",
  "name": "Example name",
  "nickname": "Example nickname",
  "customId": "9ABCDEF1234567",
  "email": "merchant@example.com",
  "inviteSent": true,
  "claimedTime": 1718153645000,
  "deletedTime": 1718153645000,
  "pin": "example-pin",
  "unhashedPin": "example-unhashedPin",
  "role": "OWNER",
  "roles": [],
  "isOwner": true,
  "shifts": [],
  "payments": [],
  "orders": [],
  "employeeCards": [],
  "merchant": {}
}