# mba-cli address

> Read addresses (key-scoped)

Read addresses (key-scoped)

CLI version: `0.3.2`

## Commands

### mba-cli address get

Get one address by id

Retrieve address by ID

Fetches detailed address information using its unique identifier. Returns complete address data including associated metadata.

Get one address by id

Flags:

- `--id` (string): Address record id

API endpoints:

- GET /addresses/{id} — https://mybusinessapp.co.za/developers/api/address#tag/Address/get_single_address

### mba-cli address ls

List addresses

List all addresses with pagination and filtering

Retrieves a paginated list of addresses with optional customer-based filtering. Supports customizable page size and customer-specific views. Returns address records with their associated metadata.

List addresses

Flags:

- `--all` (bool, default `false`): Return all rows (paginate=false)
- `--customer-id` (string): Query parameter customerId (from the API spec)
- `--limit` (int, default `20`): Query parameter limit (from the API spec)
- `--page` (int, default `1`): Query parameter page (from the API spec)
- `--paginate` (bool, default `true`): Query parameter paginate (from the API spec)

API endpoints:

- GET /addresses — https://mybusinessapp.co.za/developers/api/address#tag/Address/get_all_addresses

---

[Rendered page](https://mybusinessapp.co.za/developers/cli/reference/address)

© MyBusinessApp (Pty) Ltd. Proprietary documentation — do not republish.