VH3 AI icon

VH3 AI

Read and write BigChange field service data and access VH3 AI intelligence features — jobs, contacts, invoices, reports, search, cases, and more.

Actions200

Search (VH3 AI) → Search Outcomes

AI-generated

Summary

Searches VH3 AI outcomes using a required natural-language query, with optional filters and a result limit. Returns matching outcome records for use in downstream workflow steps.

Inputs

  • Query Text (required) — Natural-language search query.
  • Category ID — Filter by job category ID.
  • Contact ID — Filter by customer or contact ID.
  • Date From — Keep hits whose actualStartAt is on or after this date; applied client-side after the API response.
  • Date To — Keep hits whose actualStartAt is on or before this date; applied client-side after the API response.
  • Limit — Maximum results to return (1–100; defaults to 50).
  • Max Age (Months) — Keep hits whose actualStartAt is within the last specified number of months (1–240; defaults to 6). Ignored when Date From is set.
  • Resource ID — Filter by engineer or resource ID.
  • Result — Filter enriched outcome hits by job result; server-side and only applicable to enriched search.
  • Site Key — Filter by site key.
  • Status — Filter enriched outcome hits by job status; server-side and only applicable to enriched search.
  • Type ID — Filter by job type ID.

Output shape

A list of matching outcome records.

Date From, Date To, and Max Age (Months) are client-side filters applied after the API response. The Result and Status filters are declared for enriched outcome search; their effect for this operation is not established by the provided source excerpt.

Links

Discussion