Search Clients

Search clients by name or contact information

Geoff Mina avatar
Written by Geoff Mina
Updated over a week ago

Search for client records in your Moxie CRM by name or contact information
โ€‹
Endpoint: /action/clients/search?query=

Method: GET

Request Params:

  • query - client name starts with, contact email starts with, contact full name contains

Response Body (example): Empty array returned if no results matched

[
{
"name": "",
"clientType": "Client",
"initials": "",
"address1": "",
"address2": "",
"city": "",
"locality": "",
"postal": "",
"country": "",
"website": "",
"phone": "",
"color": "",
"taxId": "",
"leadSource": "",
"archive": false,
"paymentTerms": {
"paymentDays": 0,
"latePaymentFee": 0.00,
"hourlyAmount": 0.00,
"whoPaysCardFees": "Client",
},
"payInstructions": "",
"hourlyAmount": 0.00,
"roundingIncrement": 0,
"currency": "USD",
"stripeClientId": "",
"notes": "",
"contacts":[
{
"firstName": "",
"lastName": "",
"role": "",
"phone": "",
"email": "",
"notes": "",
"defaultContact": false,
"invoiceContact": false,
"portalAccess": false,
}
]
}
]
Did this answer your question?