list_addresses
List addresses with pagination, filterable by customer or supplier for scoped retrieval.
Instructions
List addresses. Normally scope to a customer_id or supplier_id.
Scoping uses the nested route (/api/customers/{id}/addresses); the
flat /api/addresses?filter[customer_id]= query raises JA011.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_addresses"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | JSON:API sort. | |
| fields | No | Comma-separated subset of fields to return. | |
| page_size | No | Items per page (1-500). | |
| customer_id | No | Filter to a specific customer's addresses. | |
| page_number | No | 1-based page number. | |
| supplier_id | No | Filter to a specific supplier's addresses. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||