Skip to main content

Search Contacts

GET /public/action/contacts/search

Lists / searches active contacts.

Authentication: X-API-KEY header (see Authentication).

Query parameters

ParameterTypeRequiredDescription
idstringNoExact contact id. When provided, returns just that contact (ignores query).
querystringNoSearch term. Omit to list all active contacts.

What query matches — a contact is returned if any of these contain the term (case-insensitive):

  • email — contains
  • first name — contains
  • last name — contains

Request

curl -X GET https://api.withmoxie.com/public/action/contacts/search?query=VALUE \
-H "X-API-KEY: your_api_key_here"

Response

Returns an array of Contact objects.

[
{
"id": "66b0f3b2c3a9e40012ab5500",
"accountId": 10016,
"clientId": "66b0f2a1c3a9e40012ab34cd",
"firstName": "Jane",
"lastName": "Doe",
"role": "Billing",
"email": "jane@acme.example",
"phone": "+36 1 234 5678",
"mobile": null,
"defaultContact": false,
"invoiceContact": true,
"portalAccess": true,
"customValues": []
}
]