Find contacts
list_contactsFinds the organisation's contacts - the people and businesses it deals with, such as suppliers, tenants, contractors, property owners, landlords and accountants - with their ids, names, contact types and contact details. IRD numbers and bank account numbers are never included. Use the ids with the other tools; to find the contact a person names, search by part of the name. When the person's words match more than one, or none, show them the closest and ask which they mean; never guess an id. Pages of up to 500: the answer gives items, total, offset and limit.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many records to return, 1 to 500. The default is 100. | |
| offset | No | How many records to skip, to page through a long list: the answer's total says how many there are. The default is 0. | |
| search | No | Part of a name or email address to look for. | |
| contact_type | No | Only contacts of this type: supplier, tenant, contractor, property-owner, landlord or accountant, or a type the organisation added itself (list_choices gives every one with its label). | |
| organisation_id | No | The id of the organisation to use, from list_organisations. Leave it out when the connection covers only one organisation; it is required when it covers more than one. |