Customers

Returns a list of customers. The list can be filtered by customer name.<br/><br/> A note about contact items on each person:<br> <ul> <li>The contact items are an array of objects. Each object has a contactType and a contactValue. <li>The contactType can be one of the following: email, phone, mobile, or fax. <li>The contactValue can be an email address or phone number. </ul>

get/customers

Query parameters

pageSizeinteger
'asc'
OR
'desc'
pageCursorstring
'name'
OR
'createdAt'
filterSearchTextstring

Searchable fields:

  • customerFullName
  • mainContact.firstName
  • mainContact.lastName
  • mainContact.contactItems[].contactValue
  • billingContact.firstName
  • billingContact.lastName,
  • billingContact.contactItems[].contactValue

Response

Successful Response

resultstring required

Changes

No recorded changes to this endpoint across all 1 revision of this API.