/customers
GET {{baseUrl}}/customers?embed=<string>&fields=<string>&sort=<string>&trade=<integer>&count=<integer>&offset=<integer>
Returns all customers. By default the first 50 regular customers are returned, sorted by creation date
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
embed | string | Comma seperated list of properties to embed | |
fields | string | Comma seperated list of properties to include | |
sort | string | If not included, results are sorted by creation date | |
trade | string | 0 if the results should contain regular customers, 1 if the results should contain trade customers | |
count | string | The maximum number of results to be returned | |
offset | string | The starting position for the returned values |
RESPONSES
status: OK
[{"id":"\u003cinteger\u003e","trade":"\u003cboolean\u003e","active":"\u003cboolean\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","addressLine3":"\u003cstring\u003e","city":"\u003cstring\u003e","postcode":"\u003cstring\u003e","country":{"id":"\u003cinteger\u003e"},"state":{"id":"\u003cinteger\u003e"},"notes":"\u003cstring\u003e","rewardPoints":"\u003cinteger\u003e","acceptsMarketing":"\u003cboolean\u003e","companyName":"\u003cstring\u003e","mobilePhone":"\u003cstring\u003e","website":"\u003cstring\u003e","vatNumber":"\u003cstring\u003e","tradeGroupId":"\u003cinteger\u003e","additionalData":{"0":"\u003cstring\u003e","1":"\u003cstring\u003e","2":"\u003cstring\u003e"}},{"id":"\u003cinteger\u003e","trade":"\u003cboolean\u003e","active":"\u003cboolean\u003e","firstName":"\u003cstring\u003e","lastName":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","addressLine1":"\u003cstring\u003e","addressLine2":"\u003cstring\u003e","addressLine3":"\u003cstring\u003e","city":"\u003cstring\u003e","postcode":"\u003cstring\u003e","country":{"id":"\u003cinteger\u003e"},"state":{"id":"\u003cinteger\u003e"},"notes":"\u003cstring\u003e","rewardPoints":"\u003cinteger\u003e","acceptsMarketing":"\u003cboolean\u003e","companyName":"\u003cstring\u003e","mobilePhone":"\u003cstring\u003e","website":"\u003cstring\u003e","vatNumber":"\u003cstring\u003e","tradeGroupId":"\u003cinteger\u003e","additionalData":{"0":"\u003cstring\u003e","1":"\u003cstring\u003e","2":"\u003cstring\u003e"}}]