List customers
Customers in your Acumatica tenant with their ID, name and status.
GET https://cotlet.dev/api/v1/acumatica/customers
read
Lists customers, filtered by a name search or by status. Use customer_id from each item in create_ar_invoice and list_invoices. The search matches the name as Acumatica shows it, so a short fragment can return several customers and your agent should ask when more than one fits.
Parameters
| Name | Type | Description |
|---|---|---|
| search string | string | Part of the customer name. |
| status string | string | Status as Acumatica shows it, for example Active. |
| limit integer | integer | Rows per page. Default: 50. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/acumatica/customers \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("acumatica", "list_customers")const result = await cotlet.call('acumatica', 'list_customers');cotlet call acumatica list_customersExample response
{
"customers": [
{
"customer_id": "C000045",
"name": "Harbor Dental Group",
"status": "Active"
},
{
"customer_id": "C000051",
"name": "Lakeside Studio",
"status": "Active"
}
],
"next_cursor": null
}