# mba-cli employee

> Read employees (key-scoped)

Read employees (key-scoped)

CLI version: `0.3.2`

## Commands

### mba-cli employee get

Get one employee by id

Retrieve employee by ID

Fetches detailed employee information using their unique identifier. Returns complete profile including role assignments, team associations, and profile metadata.

Get one employee by id

Flags:

- `--id` (string): Employee record id

API endpoints:

- GET /employees/{id} — https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_single_employee

### mba-cli employee get-by-uid

Get one employee by auth uid

Retrieve employee by UID

Fetches employee profile using their unique identifier (UID). Alternative lookup method that uses UID instead of internal ID. Returns complete employee data including roles and associations.

Get one employee by auth uid

Flags:

- `--uid` (string): Employee auth uid

API endpoints:

- GET /employees/uid/{uid} — https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_single_employee_by_uid

### mba-cli employee ls

List employees

List all employees with pagination and filtering

Retrieves a paginated list of employees with optional team-based filtering. Supports customizable page size and team-specific views. Returns employee profiles with their associated metadata, roles, and team relationships.

List employees

Flags:

- `--all` (bool, default `false`): Return all rows (paginate=false)
- `--limit` (int, default `20`): Query parameter limit (from the API spec)
- `--page` (int, default `1`): Query parameter page (from the API spec)
- `--paginate` (bool, default `true`): Query parameter paginate (from the API spec)
- `--team-id` (string): Query parameter teamId (from the API spec)
- `--team-ids` (string): Query parameter teamIds (from the API spec)

API endpoints:

- GET /employees — https://mybusinessapp.co.za/developers/api/employee#tag/Employee/get_all_employees

---

[Rendered page](https://mybusinessapp.co.za/developers/cli/reference/employee)

© MyBusinessApp (Pty) Ltd. Proprietary documentation — do not republish.