Search contacts
brightpearl_search_contactsSearch contacts (customers, suppliers and staff). Every filter is optional and they combine (AND); each result row has contactId, primaryEmail, firstName, lastName, companyName, isSupplier, isStaff, isCustomer, createdOn, updatedOn, lastOrderedOn and more. Use brightpearl_get_contacts for the full record. GET /contact-service/contact-search.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Matches any of the contact's email addresses (case-insensitive match). | ||
| phone | No | Matches any of the telephone or mobile numbers. | |
| tag_ids | No | Only contacts with these tag ids (one or more ids). | |
| is_staff | No | Only staff (true). | |
| last_name | No | Last name (case-insensitive match). | |
| page_size | No | Rows per page, 1-500 (default 25). | |
| created_to | No | Created: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| first_name | No | First name (case-insensitive match). | |
| updated_to | No | Last updated: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| company_ids | No | Only contacts of these company ids (one or more ids). | |
| contact_ids | No | Only these contacts (one or more ids). | |
| is_customer | No | Only customers (true). | |
| is_supplier | No | Only suppliers (true). | |
| company_name | No | Company name (case-insensitive match). | |
| created_from | No | Created: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| first_result | No | Position of the first row to return, from 1 (default 1). Pass the previous reply's next_first_result for the next page. | |
| newest_first | No | Newest (highest id) first. Default: oldest first. | |
| updated_from | No | Last updated: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| last_ordered_to | No | Last ordered: on or before this day (yyyy-mm-dd, whole day included) or ISO 8601 date-time with timezone. | |
| last_ordered_from | No | Last ordered: on or after this day (yyyy-mm-dd) or ISO 8601 date-time with timezone. | |
| exact_primary_email | No | Exact primary email address. |