List customers
Customer cards with card ID, name, email and payment terms, filtered by name or email.
MCP tool myob_read → list_customers
read
Returns customer cards in alphabetical order. Search matches the name, the card ID or the email. Active customers are returned unless include_inactive is true. Use customer_id from each item in create_invoice, record_invoice_payment and send_customer_statement. Pages hold up to 100 customers; pass next_cursor back as cursor for the next page.
Parameters
| Name | Type | Description |
|---|---|---|
| search string | string | Customer name, card ID or email. |
| include_inactive boolean | boolean | Include customers marked inactive. Default: false. |
| limit integer | integer | 1 to 100. Default: 50. |
| cursor string | string | Next page cursor from the previous call. |
tools/call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "myob_read",
"arguments": {
"operation": "list_customers",
"arguments": {}
}
}
}Example response
{
"content": [
{
"type": "text",
"text": "{ ... same JSON as structuredContent ... }"
}
],
"structuredContent": {
"customers": [
{
"customer_id": "CUS000012",
"name": "Harbour Cafe Pty Ltd",
"email": "accounts@harbourcafe.example",
"terms": "In a given number of days: 14",
"active": true
}
],
"next_cursor": null
},
"isError": false
}