List customers
Customer cards with card ID, name, email and payment terms, filtered by name or email.
GET https://cotlet.dev/api/v1/myob/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. |
Request
curl https://cotlet.dev/api/v1/myob/customers \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("myob", "list_customers")const result = await cotlet.call('myob', 'list_customers');cotlet call myob list_customersExample response
{
"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
}