Customers
GET /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>
Request
- Base URLhttps://api.fergus.com
- Auth
- OAuth 2Authorization codehttps://auth.fergus.com/oauth2/authorizeToken URLhttps://auth.fergus.com/oauth2/token
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageSizeinteger
pageCursorstring
filterSearchTextstring
Searchable fields:
- customerFullName
- mainContact.firstName
- mainContact.lastName
- mainContact.contactItems[].contactValue
- billingContact.firstName
- billingContact.lastName,
- billingContact.contactItems[].contactValue
Response
Successful Response
Changes
No recorded changes to this operation across all 18 revisions of this API.