VUZDevelopers

Find clients by exact name match

GET
/clients/find-by-name

Searches for clients with exact name match (case-insensitive) within a specific business.

Use Cases:

  • Check if a client with a given name already exists before creating
  • Client lookup during document creation
  • Avoid duplicate client creation

Query Parameters:

  • name: Client name to search for (exact match, case-insensitive)
  • businessId: Business ID for multi-tenant scoping (required)

Returns:

  • Array of clients that match the exact name (can be multiple)
  • Empty array if no matches found

Example: GET /api/v1/clients/find-by-name?name=דוד כהן&businessId=xxx

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

name*string

Client name to search for (exact match, case-insensitive)

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/clients/find-by-name?name=%D7%93%D7%95%D7%93+%D7%9B%D7%94%D7%9F"
{  "items": [    {      "id": "770e8400-e29b-41d4-a716-446655440000",      "name": "דוד כהן",      "type": "private",      "phone": "+972-50-7654321",      "email": "david.cohen@example.com",      "address": "רחוב דיזנגוף 50, תל אביב, 6433109",      "vatNumber": "512345678",      "contactPerson": "שרה לוי",      "notes": "לקוח VIP - תנאי תשלום מיוחדים",      "isActive": true,      "origin": "web",      "businessId": "660e8400-e29b-41d4-a716-446655440000",      "userId": "550e8400-e29b-41d4-a716-446655440000",      "createdAt": "2025-01-10T08:00:00.000Z",      "updatedAt": "2025-11-06T14:30:00.000Z",      "portalEnabled": false,      "portalSlug": "my-business",      "portalUrl": "https://app.vuz.co.il/portal/my-business",      "portalLastLoginAt": "2019-08-24T14:15:22Z",      "portalInviteSentAt": "2019-08-24T14:15:22Z"    }  ]}