mba-cli booking

3 commands

Read bookings (key-scoped)

Synopsis#

bash

mba-cli booking <command> [flags]

Available commands#

mba-cli booking getGet one booking by id

Retrieve a booking by id Returns the booking with the given `id` for the tenant identified by the API key, with its associated data. Related: `List bookings`. Get one booking by id

--id

string

Booking record id

GET/bookings/{id}

mba-cli booking lsList bookings

List bookings Returns the bookings for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; filter by customer, employee, state, date range, and team. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Search bookings`, `Retrieve a booking by id`. List bookings

--all	bool = false	Return all rows (paginate=false)
--approved	bool	Query parameter approved (from the API spec)
--booking-state	string	Query parameter bookingState (from the API spec)
--customer-id	string	Query parameter customerId (from the API spec)
--employee-role	string	Query parameter employeeRole (from the API spec)
--from-date	string	Query parameter fromDate (from the API spec)
--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)
--paid	bool	Query parameter paid (from the API spec)
--sort-key	string	Query parameter sortKey (from the API spec)
--sort-value	string	Query parameter sortValue (from the API spec)
--team-id	string	Query parameter teamId (from the API spec)
--team-ids	string	Query parameter teamIds (from the API spec)
--to-date	string	Query parameter toDate (from the API spec)
--transport-mode	string	Query parameter transportMode (from the API spec)

GET/bookings

mba-cli booking searchText-search bookings

Search bookings Text-searches the tenant's bookings by `query`. Paginated: use `page`/`limit` or `paginate=false`; also supports customer, employee, state, date-range, and team filters. Related: `List bookings`. Text-search bookings

--all	bool = false	Return all rows (paginate=false)
--approved	bool	Query parameter approved (from the API spec)
--booking-state	string	Query parameter bookingState (from the API spec)
--customer-id	string	Query parameter customerId (from the API spec)
--employee-role	string	Query parameter employeeRole (from the API spec)
--from-date	string	Query parameter fromDate (from the API spec)
--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)
--paid	bool	Query parameter paid (from the API spec)
--query	string	Query parameter query (from the API spec)
--sort-key	string	Query parameter sortKey (from the API spec)
--sort-value	string	Query parameter sortValue (from the API spec)
--team-id	string	Query parameter teamId (from the API spec)
--to-date	string	Query parameter toDate (from the API spec)
--transport-mode	string	Query parameter transportMode (from the API spec)

GET/bookings/search

Was this page helpful?