/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

KeyDatatypeRequiredDescription
embedstringComma seperated list of properties to embed
fieldsstringComma seperated list of properties to include
sortstringIf not included, results are sorted by creation date
tradestring0 if the results should contain regular customers, 1 if the results should contain trade customers
countstringThe maximum number of results to be returned
offsetstringThe starting position for the returned values

RESPONSES

status: OK

[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;trade&quot;:&quot;\u003cboolean\u003e&quot;,&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;phone&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine1&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine2&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine3&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;postcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;},&quot;state&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;},&quot;notes&quot;:&quot;\u003cstring\u003e&quot;,&quot;rewardPoints&quot;:&quot;\u003cinteger\u003e&quot;,&quot;acceptsMarketing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;companyName&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobilePhone&quot;:&quot;\u003cstring\u003e&quot;,&quot;website&quot;:&quot;\u003cstring\u003e&quot;,&quot;vatNumber&quot;:&quot;\u003cstring\u003e&quot;,&quot;tradeGroupId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;additionalData&quot;:{&quot;0&quot;:&quot;\u003cstring\u003e&quot;,&quot;1&quot;:&quot;\u003cstring\u003e&quot;,&quot;2&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;trade&quot;:&quot;\u003cboolean\u003e&quot;,&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;phone&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine1&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine2&quot;:&quot;\u003cstring\u003e&quot;,&quot;addressLine3&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;postcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;},&quot;state&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;},&quot;notes&quot;:&quot;\u003cstring\u003e&quot;,&quot;rewardPoints&quot;:&quot;\u003cinteger\u003e&quot;,&quot;acceptsMarketing&quot;:&quot;\u003cboolean\u003e&quot;,&quot;companyName&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobilePhone&quot;:&quot;\u003cstring\u003e&quot;,&quot;website&quot;:&quot;\u003cstring\u003e&quot;,&quot;vatNumber&quot;:&quot;\u003cstring\u003e&quot;,&quot;tradeGroupId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;additionalData&quot;:{&quot;0&quot;:&quot;\u003cstring\u003e&quot;,&quot;1&quot;:&quot;\u003cstring\u003e&quot;,&quot;2&quot;:&quot;\u003cstring\u003e&quot;}}]