VUZDevelopers

Get all businesses

GET
/businesses
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

search?string

Search by business name or owner phone number (partial match, case-insensitive)

isActive?boolean

Filter by active status. Only active businesses can create documents.

isOnTrial?boolean

Filter by trial status. Trial businesses have limited features.

page?number

Page number (starting from 1)

Range1 <= value
Default1
limit?number

Number of items per page (max 100)

Range1 <= value <= 100
Default10
includeAccountManaged?boolean

Multi-business-per-account: when true (and the caller is an account manager), the result ALSO includes businesses created by sub-users under this account (i.e. business.accountId = currentUser.id but business.userId != currentUser.id). Used by the My Businesses settings page so the account manager sees every business that consumes their billing pool. Defaults to false (preserves today's behavior).

Defaultfalse

Response Body

application/json

curl -X GET "https://example.com/businesses"
{  "items": [    {      "id": "660e8400-e29b-41d4-a716-446655440000",      "businessName": "עסק של נאור - ייעוץ עסקי",      "businessType": "osek_murshe",      "accountingBasis": "cash",      "vatNumber": "123456789",      "vatRate": 17,      "address": "רחוב הרצל 123, תל אביב, 6777102",      "phone": "+972-50-1234567",      "email": "naor@business.co.il",      "ownerPhone": "+972-50-1234567",      "legalName": "נאור דהן",      "showLegalNameOnDocuments": true,      "documentSubline": "פתרונות תוכנה וייעוץ טכנולוגי",      "isActive": true,      "language": "he",      "currency": "ILS",      "logoUrl": "/api/v1/files/logos/660e8400-e29b-41d4-a716-446655440000.png",      "receiptStartNumber": 50001,      "taxInvoiceReceiptStartNumber": 65001,      "creditNoteStartNumber": 80001,      "taxInvoiceStartNumber": 60001,      "quoteStartNumber": 90001,      "dealBillStartNumber": 70001,      "userId": "550e8400-e29b-41d4-a716-446655440000",      "economicSectorId": "880e8400-e29b-41d4-a716-446655440000",      "economicSector": {},      "createdAt": "2025-01-15T10:00:00.000Z",      "updatedAt": "2025-11-06T14:30:00.000Z"    }  ],  "total": 12,  "page": 1,  "limit": 10}