Search
Polymorphic read-only search across your Vruum workspace.
One tool for every list/queue/search read. Pass type to pick the entity: people (your pipeline — keyword query, batch dedup array, or list-mode filters), companies (company-domain contact search for decision-makers — requires filters.domain), directory_people (the shared people directory — requires filters.query), and directory_companies (the shared company directory — filters.query?, filters.industry?, or both; industry is the canonical enum, including Unspecified for missing source data). Directory results contain contact/company/freshness fields only, never another tenant's CRM state. Other types are deals, objectives, messages (outreach queue), engagements (LinkedIn engagement queue), content (LinkedIn content calendar), claims (the hypothesis ledger: falsifiable beliefs with evidence-backed confidence — filter by status or scope; render one with fetch type='claim'), kb (knowledge-base search), skills (published skills), cta_links, warm_paths (open targets that have a warm intro path — see find_warm_path for one target), relationship_attempts (the durable action timeline shared with the Relationships workspace).
All types except companies read internal, tenant-scoped data only. Pagination (limit/offset) is supported for people (list mode), deals, messages, engagements, warm_paths, and relationship_attempts; other types reject it. Results are returned under {type, results} with each entity type's native payload shape.
Objective routing: use type='objectives' here to list objectives (newest-moved first; filters.status). To read one objective by UUID with its live pins and members count, use fetch with type='objective'. To create, update, clone, retire, pause, launch, or manage objective members, use manage_outreach. A paused objective must pass forecast review and launch approval before it becomes active again.
Request
- Base URL: https://api.vruum.ai
- URL: https://api.vruum.ai/api/facade/search
- Auth: HTTPBearer (a scheme the document does not define)
Request body
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.