mba-cli customer

3 commands

Read customers (key-scoped)

Synopsis#

bash

mba-cli customer <command> [flags]

Available commands#

mba-cli customer getGet one customer by id

Retrieve a customer by id Returns the customer with the given `id` for the tenant identified by the API key, with profile metadata and team relationships. Related: `List customers`. Get one customer by id

--id

string

Customer record id

GET/customers/{id}

mba-cli customer lsList customers (default: page 1, 20 per page)

List customers Returns the customers in the tenant identified by the API key. Paginated: use `page`/`limit`, or `paginate=false` to return every row in one page. Filter by team (`teamId`/`teamIds`), creation date (`fromDate`/`toDate`), activity (`hasBookings`/`hasPets`/`hasAddresses`), flags (`isDifficult`/`isLatePayer`), booking/pet counts, and custom fields (`cf_<fieldId>`). To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Search customers`, `Retrieve a customer by id`. List customers (default: page 1, 20 per page)

--all	bool = false	Return all rows (paginate=false)
--from-date	string	Query parameter fromDate (from the API spec)
--has-addresses	bool	Query parameter hasAddresses (from the API spec)
--has-bookings	bool	Query parameter hasBookings (from the API spec)
--has-pets	bool	Query parameter hasPets (from the API spec)
--is-difficult	bool	Query parameter isDifficult (from the API spec)
--is-late-payer	bool	Query parameter isLatePayer (from the API spec)
--limit	int = 20	Query parameter limit (from the API spec)
--max-bookings	int	Query parameter maxBookings (from the API spec)
--max-pets	int	Query parameter maxPets (from the API spec)
--min-bookings	int	Query parameter minBookings (from the API spec)
--min-pets	int	Query parameter minPets (from the API spec)
--page	int = 1	Query parameter page (from the API spec)
--paginate	bool = true	Query parameter paginate (from the API spec)
--query	string	Query parameter query (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)

GET/customers

mba-cli customer searchText-search customers

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

--all	bool = false	Return all rows (paginate=false)
--from-date	string	Query parameter fromDate (from the API spec)
--has-addresses	bool	Query parameter hasAddresses (from the API spec)
--has-bookings	bool	Query parameter hasBookings (from the API spec)
--has-pets	bool	Query parameter hasPets (from the API spec)
--is-difficult	bool	Query parameter isDifficult (from the API spec)
--is-late-payer	bool	Query parameter isLatePayer (from the API spec)
--limit	int = 20	Query parameter limit (from the API spec)
--max-bookings	int	Query parameter maxBookings (from the API spec)
--max-pets	int	Query parameter maxPets (from the API spec)
--min-bookings	int	Query parameter minBookings (from the API spec)
--min-pets	int	Query parameter minPets (from the API spec)
--page	int = 1	Query parameter page (from the API spec)
--paginate	bool = true	Query parameter paginate (from the API spec)
--query	string	Query parameter query (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)

GET/customers/search

Was this page helpful?