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 (Enriched)

AI-generated

Summary

Searches enriched VH3 AI job outcomes using a required natural-language query, with optional filters for job, customer, site, and date. Returns matching outcome records for 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 results whose actualStartAt is on or after this date; applied client-side after the API response.
  • Date To — Keep results whose actualStartAt is on or before this date; applied client-side after the API response.
  • Limit — Maximum number of results to return; defaults to 50 (UI range 1–100).
  • Max Age (Months) — Keep results with actualStartAt within the last N months; defaults to 6. Applied client-side and ignored when Date From is set.
  • Resource ID — Filter by engineer or resource ID.
  • Result — Filter enriched outcome hits by job result on the server.
  • Site Key — Filter by site key.
  • Status — Filter enriched outcome hits by job status on the server.
  • Type ID — Filter by job type ID.

Output shape

A list of matching enriched outcome records.

Date From, Date To, and Max Age (Months) are client-side filters on actualStartAt; Max Age is ignored when Date From is set. The operation requires VH3 AI credentials with a company ID for enrichment requests.

Links

Discussion