mba-cli address

2 commands

Read addresses (key-scoped)

Synopsis#

bash

mba-cli address <command> [flags]

Available commands#

mba-cli address getGet one address by id

Retrieve an address by id Returns the address with the given `id` from the tenant identified by the API key. Returns 404 if the id does not exist in this tenant. Related: `List addresses`. Get one address by id

--id

string

Address record id

GET/addresses/{id}

mba-cli address lsList addresses

List addresses Returns the addresses in the tenant identified by the API key. Paginated: use `page`/`limit`, or `paginate=false` to return every row in one page. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an address by id`. List addresses

--all	bool = false	Return all rows (paginate=false)
--customer-id	string	Query parameter customerId (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)

GET/addresses

Was this page helpful?