{"openapi":"3.1.0","info":{"title":"GET /api/v1/search","version":"1.0.0","description":"Global search"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/search":{"get":{"tags":["search"],"summary":"Global search","description":"Search across products, variants, customers, invoices, vendors, and more.","operationId":"search_entities_api_v1_search_get","parameters":[{"name":"entity_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Limit to: products, variants, customers, invoices, vendors, transactions, journal_entries, ledgers, emails","title":"Entity Type"},"description":"Limit to: products, variants, customers, invoices, vendors, transactions, journal_entries, ledgers, emails"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Results after this date (ISO 8601: YYYY-MM-DD)","title":"Date From"},"description":"Results after this date (ISO 8601: YYYY-MM-DD)"},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Results before this date (ISO 8601: YYYY-MM-DD)","title":"Date To"},"description":"Results before this date (ISO 8601: YYYY-MM-DD)"},{"name":"search_term","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":200,"title":"Search Term"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}],"description":"Pagination limit","title":"Limit"},"description":"Pagination limit"},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"},"description":"Cursor for pagination"},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Pagination direction: 'next' or 'prev'","default":"next","title":"Direction"},"description":"Pagination direction: 'next' or 'prev'"},{"name":"include_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count (expensive - avoid if possible)","default":false,"title":"Include Total Count"},"description":"Whether to include total count (expensive - avoid if possible)"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.","title":"Sort By"},"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None."},{"name":"descending","in":"query","required":false,"schema":{"type":"boolean","description":"Sort direction: true for descending (newest/largest first), false for ascending","default":true,"title":"Descending"},"description":"Sort direction: true for descending (newest/largest first), false for ascending"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SearchMetadata":{"properties":{"total_count":{"type":"integer","title":"Total Count","description":"Total matches across all entity types."},"search_term":{"type":"string","title":"Search Term","description":"The search term used."}},"type":"object","required":["total_count","search_term"],"title":"SearchMetadata","description":"Metadata about search results."},"SearchResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Whether search completed successfully.","default":true},"results":{"$ref":"#/components/schemas/SearchResults","description":"Search results by entity type."}},"type":"object","required":["results"],"title":"SearchResponse","description":"Response schema for global search.\n\nSearches across multiple entity types simultaneously\nand returns results grouped by type."},"SearchResults":{"properties":{"products":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Products","description":"Matching products.","default":[]},"variants":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Variants","description":"Matching product variants.","default":[]},"invoices":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Invoices","description":"Matching invoices.","default":[]},"bills":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Bills","description":"Matching bills.","default":[]},"inventory_orders":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Inventory Orders","description":"Matching inventory orders.","default":[]},"shipments":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Shipments","description":"Matching shipments.","default":[]},"customers":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Customers","description":"Matching customers.","default":[]},"vendors":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Vendors","description":"Matching vendors.","default":[]},"journal_entries":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Journal Entries","description":"Matching journal entries.","default":[]},"transactions":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Transactions","description":"Matching transactions.","default":[]},"ledgers":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Ledgers","description":"Matching ledger accounts.","default":[]},"emails":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Emails","description":"Matching emails.","default":[]},"metadata":{"$ref":"#/components/schemas/SearchMetadata","description":"Search metadata."}},"type":"object","required":["metadata"],"title":"SearchResults","description":"Search results grouped by entity type.\n\n**Searchable fields by entity:**\n- `products`: name, type\n- `variants`: name, sku, manufacturer_sku, unit_price*, unit_cost*\n- `invoices`: number, description, total*\n- `bills`: bill_number, description, amount*, expected_amount*\n- `customers`: name, email\n- `vendors`: name, email\n- `journal_entries`: description\n- `transactions`: description, amount*\n- `ledgers`: name, description\n- `emails`: subject, sender_email, description\n- `inventory_orders`: name, po_number, description, total*\n- `shipments`: tracking_number, description\n\n*Numeric fields: enter a dollar amount (e.g. ``5.00`` or ``$1,250``)\nand matching records will be included alongside text matches.","example":{"customers":[{"email":"billing@acme.com","id":"...","name":"Acme Corp"}],"invoices":[],"metadata":{"search_term":"acme","total_count":3},"products":[{"id":"...","name":"Widget Pro","type":"physical"}],"transactions":[{"amount":150000,"description":"ACME CORP PAYMENT","id":"..."}]}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}