VUZDevelopers

Get a client by ID

GET
/clients/{id}

Retrieves a single client by its unique identifier.

Multi-Tenant Security: Only users who own the business that this client belongs to can access this client. Attempting to access a client from another user's business will return 403 Forbidden.

Response Includes:

  • Complete client details
  • Israeli tax type and VAT number (if applicable)
  • Contact information
  • Notes and metadata
  • Timestamps

Example Use Case: Loading client details before creating an invoice, or viewing client profile in dashboard.

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

Path Parameters

id*string

Client unique identifier (UUID)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/clients/770e8400-e29b-41d4-a716-446655440000"
{  "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"}