mba-cli employee

3 commands

Read employees (key-scoped)

Synopsis#

bash

mba-cli employee <command> [flags]

Available commands#

mba-cli employee getGet one employee by id

Retrieve an employee by id Returns the employee with the given `id`, including role assignments and team associations. Related: `List employees`. Get one employee by id

--id

string

Employee record id

GET/employees/{id}

mba-cli employee get-by-uidGet one employee by auth uid

Retrieve an employee by Firebase UID Returns the employee with the given Firebase `uid` (useful when you only have the signed-in user's id). Related: `Retrieve an employee by id`. Get one employee by auth uid

--uid

string

Employee auth uid

GET/employees/uid/{uid}

mba-cli employee lsList employees

List employees Returns the employees for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an employee by id`, `Retrieve an employee by Firebase UID`. List employees

--all	bool = false	Return all rows (paginate=false)
--limit	int = 20	Query parameter limit (from the API spec)
--page	int = 1	Query parameter page (from the API spec)
--paginate	bool = 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)

GET/employees

Was this page helpful?