---
title: "Create an employee"
method: POST
path: "/v3/merchants/{mId}/employees"
tags: ["EMPLOYEES"]
---

# Create an employee

`POST /v3/merchants/{mId}/employees`

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

## Path parameters

- `mId` string, required

## Query parameters

- `expand` string

## Headers

- `User-Agent` string, required

## Request body

- object
  - `id` 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
  - `email` 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
  - `pin` string — Employee PIN (hashed)
  - `unhashedPin` string — Employee PIN
  - `role` 'OWNER' | 'ADMIN' | 'MANAGER' | 'EMPLOYEE' — Employee System Role
  - `roles` object[]
    - `id` string — Unique identifier.
  - `isOwner` boolean — Returns true if this employee is the owner account for this merchant
  - `shifts` object[] — This employee's shifts
    - `id` string — Unique identifier.
  - `payments` object[] — This employee's payments
    - `id` string — Unique identifier.
  - `orders` object[] — This employee's orders
    - `id` string — Unique identifier.
  - `employeeCards` object[] — This employee's employee cards
    - `id` string — Unique identifier.
  - `merchant` object — The merchant employing this employee.
    - `id` string — Unique identifier.

## Response `200`

---

[API](https://skmtc.net/clover/apis/platform-api.md) · [All operations](https://skmtc.net/clover/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clover/platform-api/revisions/08da265101a3/schema)