Skip to main content

Search Clients

GET /public/action/clients/search

Searches active clients by free-text query (matches on client name).

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

Query parameters

ParameterTypeRequiredDescription
idstringNoExact client id. When provided, returns just that client (ignores query).
querystringNoSearch term. Matched (case-insensitive) against the fields below.

What query matches — a client is returned if any of these match:

  • client name — starts with
  • client phone — starts with
  • any contact email — starts with
  • any contact full name — contains
  • any contact phone — starts with

Request

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

Response

Returns an array of matching Client objects (same shape as List Clients).

[
{
"id": "66b0f2a1c3a9e40012ab34cd",
"accountId": 10016,
"name": "Acme Kft.",
"clientType": "Client",
"city": "Budapest",
"country": "HU",
"taxId": "12345678-2-41",
"currency": "HUF",
"defaultTaxRate": 27,
"customValues": [],
"contacts": []
}
]