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 customer by ID Fetches detailed customer information using their unique identifier. Returns complete profile including team associations, Xero integration status, and custom field values. This endpoint is similar to the get_all_customers endpoint, but it only returns a single customer. Get one customer by id
--idstringCustomer record id
mba-cli customer lsList customers (default: page 1, 20 per page)
List all customers with pagination and filtering Retrieves a paginated list of customers with optional team-based filtering. Supports customizable page size and team-specific views. Returns customer profiles with their associated metadata and team relationships. Allows filtering by date range based on when customers were created using from date and to date parameters. Custom-field filters use the repeatable cf_<fieldId>=<value> convention, where fieldId is a custom_field_definitions.id. List customers (default: page 1, 20 per page)
--allbool = falseReturn all rows (paginate=false)
--from-datestringQuery parameter fromDate (from the API spec)
--has-addressesboolQuery parameter hasAddresses (from the API spec)
--has-bookingsboolQuery parameter hasBookings (from the API spec)
--has-petsboolQuery parameter hasPets (from the API spec)
--is-difficultboolQuery parameter isDifficult (from the API spec)
--is-late-payerboolQuery parameter isLatePayer (from the API spec)
--limitint = 20Query parameter limit (from the API spec)
--max-bookingsintQuery parameter maxBookings (from the API spec)
--max-petsintQuery parameter maxPets (from the API spec)
--min-bookingsintQuery parameter minBookings (from the API spec)
--min-petsintQuery parameter minPets (from the API spec)
--pageint = 1Query parameter page (from the API spec)
--paginatebool = trueQuery parameter paginate (from the API spec)
--querystringQuery parameter query (from the API spec)
--team-idstringQuery parameter teamId (from the API spec)
--team-idsstringQuery parameter teamIds (from the API spec)
--to-datestringQuery parameter toDate (from the API spec)
Was this page helpful?