Create an employee

post

https://apisandbox.dev.clover.com/v3/merchants/{mId}/employees

Creates an employee for a merchant. Accepts optional expand parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant Id

Query Params

expand

string

Expandable fields: [shifts, payments, orders, roles]

Body Params

string

Unique identifier

name

string

required

Full name of the employee

nickname

string

Nickname of the employee (shows up on receipts)

customId

string

Custom ID of the employee

string

Email of the employee (optional)

inviteSent

boolean

Returns true if this employee was sent an invite to activate their account

claimedTime

integer

Timestamp of when this employee claimed their account

deletedTime

integer

Timestamp of when this employee was deleted

string

Employee PIN (hashed)

unhashedPin

string

Employee PIN

role

string

enum

Employee System Role

Allowed:

roles

array of objects

roles

isOwner

boolean

Returns true if this employee is the owner account for this merchant

shifts

array of objects

This employee's shifts

shifts

payments

array of objects

This employee's payments

payments

orders

array of objects

This employee's orders

orders

employeeCards

array of objects

This employee's employee cards

employeeCards

merchant

object

The merchant employing this employee.

Headers

User-Agent

string

required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

200

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here!