List customers
Customers in your Pennylane account with name, type and email, optionally filtered by name.
GET https://cotlet.dev/api/v1/pennylane/customers
read
Returns the customers in the Pennylane account you signed in with, company and individual customers alike. Use customer_id from each item in create_customer_invoice and list_customer_invoices. Pages hold 1 to 100 customers; pass next_cursor back as cursor for the next page.
Parameters
| Name | Type | Description |
|---|---|---|
| name string | string | Only customers whose name contains this text. |
| 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/pennylane/customers \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("pennylane", "list_customers")const result = await cotlet.call('pennylane', 'list_customers');cotlet call pennylane list_customersExample response
{
"customers": [
{
"customer_id": 4021,
"name": "Atelier Lumen SARL",
"type": "company",
"email": "compta@atelier-lumen.example"
},
{
"customer_id": 4034,
"name": "Studio Marais SAS",
"type": "company",
"email": "factures@studio-marais.example"
}
],
"has_more": false,
"next_cursor": null
}