List clients
Clients with ID, contact, currency, paid to date and outstanding balance.
GET https://cotlet.dev/api/v1/invoice-ninja/clients
read
Lists the clients of one company, with the contact, the currency the client is billed in, what the client has paid to date and the outstanding balance, the same numbers as the client overview. Search matches the client name and the contact name or email. Use client_id from each item in create_invoice, create_quote and list_invoices. Pages hold up to 100 clients; pass next_cursor back as cursor for the next page.
Parameters
| Name | Type | Description |
|---|---|---|
| company string | string | Company name, for accounts with several companies. Default: the company open when you signed in. |
| search string | string | Text to match in the client name or contact. |
| limit integer | integer | 1 to 100. Default: 20. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/invoice-ninja/clients \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("invoice-ninja", "list_clients")const result = await cotlet.call('invoice-ninja', 'list_clients');cotlet call invoice-ninja list_clientsExample response
{
"clients": [
{
"client_id": "Wp3xq8Rnd5",
"name": "Northwind Studio",
"contact": "Dana Weiss",
"email": "billing@northwind.example",
"currency": "USD",
"paid_to_date": 4300,
"balance": 1200
},
{
"client_id": "Bk92tLmq1x",
"name": "Brightwave Ltd",
"contact": "Tom Hale",
"email": "ap@brightwave.example",
"currency": "USD",
"paid_to_date": 7200,
"balance": 1800
}
],
"next_cursor": null
}