---
title: "Get all employees"
method: GET
path: "/v3/merchants/{mId}/employees"
tags: ["EMPLOYEES"]
---

# Get all employees

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

Retrieves information about employees associated with a merchant.

## Path parameters

- `mId` string, required

## Query parameters

- `filter` string
- `expand` string

## Headers

- `User-Agent` string, required

## Response `200`

Successful response. Displays all employees for a merchant.

- object
  - `id` string — Employee identifier.
  - `name` string, required — Employee's full name.
  - `nickname` string — Employee's nick name.
  - `customId` string — Custom identifier (ID) of the employee.
  - `email` string — Employee's email address.
  - `inviteSent` boolean — Indicates whether an invite was sent to the employee to activate their account.
  - `claimedTime` integer — Time when the employee claimed their account.
  - `deletedTime` integer — Time when the employee account was deleted.
  - `pin` string — Employee’s personal identification number (hashed PIN).
  - `unhashedPin` string — Employee’s personal identification number (unhashed PIN).
  - `role` 'ADMIN' | 'MANAGER' | 'EMPLOYEE' — Employee role, for example: admin, manager, and employee.
  - `roles` object[]
    - `id` string — Role unique identifier.
  - `isOwner` boolean — Indicates whether the employee has an Owner role for the merchant account.
  - `shifts` object[] — Employee shift details.
    - `id` string — Employee shift unique identifier.
  - `payments` object[] — Payment transactions for the employee.
    - `id` string — Payment transaction unique identifier.
  - `orders` object[] — Order details for the employee.
    - `id` string — Order unique identifier.
  - `employeeCards` object[] — Employee card details.
    - `id` string — Employee card unique identifier.
  - `merchant` object — Merchant who employs the employee.
    - `id` string — Merchant unique identifier.

---

[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)