List contacts
Customers and suppliers saved in Lexware Office, searchable by name or email.
GET https://cotlet.dev/api/v1/lexware-office/contacts
read
Searches the saved contacts by name, email or customer number and returns the ID, role, billing address and email. Einmalkontakte, the one-off names kept only on a document, are not saved contacts and do not appear here.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Part of a name, email address or customer number. |
| role enum | enum | customer or vendor. Default: both. |
| 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/lexware-office/contacts \
-H "Authorization: Bearer $COTLET_API_KEY" result = client.call("lexware-office", "list_contacts") const result = await cotlet.call('lexware-office', 'list_contacts'); cotlet call lexware-office list_contacts Example response
{
"contacts": [
{
"contact_id": "c_4f2a91",
"name": "Nordlicht Design GmbH",
"role": "customer",
"customer_number": "10042",
"email": "buchhaltung@nordlicht.example",
"city": "Hamburg"
}
],
"next_cursor": null
}