List Address Book
starshipit_list_addressesLists and searches saved StarShipIt address book contacts with pagination so you can reuse delivery details and avoid re-entering addresses.
Instructions
List saved addresses from the StarShipIt address book, with optional text filtering and pagination.
When to use: Use this to:
Look up an existing contact before creating an order (avoids re-entering addresses)
Search for a specific company or person's delivery details
Browse all saved addresses for account management
Parameters:
search_term(optional) — filters by name, company, street, suburb, city, or postcode; leave blank to list alllimit(default 50, max 250) — number of addresses per pagepage(default 1) — page number for pagination; increase to load more results
Returns: An array of address objects, each containing:
id— unique address book ID (required for update/delete)code,name,companyFull address:
street,suburb,city,state,post_code,countryContact info:
phone,emailDelivery preferences:
instructions,building,carrier,signature_required
Pagination: If total_records is greater than limit × page, increment page to retrieve more results.
Errors:
401/403 — authentication failure
Empty result — no addresses match the search term or the address book is empty
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (default: 1) | |
| limit | No | Maximum number of addresses to return per page (default: 50, max: 250) | |
| search_term | No | Text to search across name, company, street, suburb, city, and postcode fields | |
| response_format | No | Output format: 'markdown' for human-readable or 'json' for machine-readable | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation or processing errors returned by StarShipIt | |
| object | No | The response payload when StarShipIt returns a non-object value | |
| success | No | StarShipIt success flag (a boolean on most endpoints) |