Mandatory Fields: None
If you make a GET request to this endpoint, by default you will receive all customer records, excluding archived records, sorted by customer name alphabetically.
The filter options are as follows:
| customer_name | Search (partial match) for the string in the customer_name field (e.g. "BROWN" will return "BROWN LTD, BROWNS LTD, NUTBROWN LTD) |
| customer_acc_code | Search (partial match) for the string in the customer_acc_code field |
| customer_city | Search (exact match) for records matching the string provided |
| customer_post_code | Search (partial match) for the string in the customer_post_code field |
| contact_email | Searches contact records for a partial match in the email field |
| customer_archived | Set to 1 if you want archived records to be included in the results (set to 0 by default) |
| pages_page | Can be used to paginate the results (ie. set to '1' for page 1, '2' for page 2, etc) |
Response
| data | An array of customer records |
| count | The total count of records which match your filter(s) |
| page | Which page of records this correlates to (add 1 and re-call to get the next page) |