Get business metadata and configuration
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
Response Body
application/json
curl -X GET "https://example.com/business-meta"{ "id": "550e8400-e29b-41d4-a716-446655440000", "createdAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z", "deletedAt": null, "businessId": "660e8400-e29b-41d4-a716-446655440000", "description": "חברת פיתוח תוכנה המתמחה באפליקציות מובייל ווב", "alternativeNames": [ "Echo Tech", "אקו טק", "אקו טכנולוגיות" ], "businessLicenseFileId": "880e8400-e29b-41d4-a716-446655440000", "licenseOcrStatus": "none", "extractedOccupationCode": "6201", "taxClearanceFileId": "990e8400-e29b-41d4-a716-446655440000", "taxClearanceOcrStatus": "none", "taxDeductionRate": 30, "taxClearanceValidFrom": "2026-01-01", "taxClearanceValidTo": "2026-12-31", "bookkeepingCertFileId": "aa0e8400-e29b-41d4-a716-446655440000", "bookkeepingCertOcrStatus": "none", "bookkeepingCertOriginalFileName": "bookkeeping-cert-2026.pdf", "bookkeepingCertMimeType": "application/pdf", "bookkeepingCertValidYear": 2026, "bookkeepingCertValidThrough": "2026-12-31", "bankAccountConfirmationFileId": "bb0e8400-e29b-41d4-a716-446655440000", "bankAccountConfirmationOcrStatus": "none", "bankAccountConfirmationOriginalFileName": "bank-account-confirmation-2026.pdf", "bankAccountConfirmationMimeType": "application/pdf", "logoUrl": "https://cdn.example.com/logos/business-123.png", "faviconUrl": "https://cdn.example.com/favicons/business-123.ico", "digitalSignatureUrl": "https://cdn.example.com/signatures/sig-123.png", "quoteSignatureVector": {}, "stampUrl": "https://cdn.example.com/stamps/stamp-123.png", "primaryColor": "#007bff", "secondaryColor": "#6c757d", "accentColor": "#28a745", "textColor": "#212529", "documentStyle": "modern", "documentHeader": { "showLogo": true, "showBusinessName": true, "showAddress": true, "showContact": true, "customText": "Thank you for your business" }, "documentFooter": { "showBankDetails": true, "showTerms": true, "showSignature": false, "customText": "All prices include VAT unless stated otherwise" }, "invoiceTemplateId": "tpl-invoice-modern-001", "receiptTemplateId": "tpl-receipt-classic-001", "quoteTemplateId": "tpl-quote-minimal-001", "emailSettings": { "fromName": "ABC Repairs", "replyTo": "info@abc-repairs.com", "signature": "Best regards,\nThe ABC Team", "defaultSubjects": { "invoice": "חשבונית מס מספר {number}", "receipt": "קבלה מספר {number}", "quote": "הצעת מחיר מספר {number}", "reminder": "תזכורת תשלום - חשבונית {number}" } }, "customFields": { "industry": "repairs", "website": "https://abc-repairs.com", "socialMedia": { "facebook": "abc-repairs", "instagram": "@abc_repairs" } }, "features": { "enableWhatsApp": true, "enableSMS": false, "enableAutoReminders": false, "enableClientPortal": true, "enableExpenseOCR": true, "enableAIRecognition": true, "enableTillsResolver": false }, "billingInfo": { "billingName": "Parent Company Ltd.", "billingVatNumber": "515123456", "billingBusinessType": "limited_company", "billingAddress": "Tel Aviv, Rothschild 1", "billingEmail": "billing@parent.co.il", "billingContactName": "John Doe" }}