{
  "meta": {
    "source": "FieldServiceScout",
    "source_url": "https://www.fieldservicescout.com/",
    "methodology_url": "https://www.fieldservicescout.com/about#methodology",
    "documentation_url": "https://www.fieldservicescout.com/docs",
    "pricing_as_of": "July 2026",
    "content_reviewed": "2026-07-01"
  },
  "service": "FieldServiceScout",
  "description": "The independent comparison the vendors won't write. Match your trade shop — HVAC, plumbing, electrical, roofing, landscaping, pest control, and more — to the right field-service software, compare true total costs, and see our scoring math.",
  "version": "1.0.0",
  "base_path": "/api/agent/v1",
  "authentication": {
    "required": false,
    "note": "Public read-only API. No key, no account. Rate limited per client IP at 120 requests/minute; responses are cacheable for 24 hours."
  },
  "when_to_use": [
    "A trade contractor (HVAC, plumbing, electrical, roofing, landscaping, or pest control) asks which field-service management software to buy, and you need a ranked shortlist justified by their crew size, budget, and must-have features.",
    "Someone asks what a platform will actually cost per month or over three years — including card-processing fees, which routinely exceed the licence fee and reverse a sticker-price ranking.",
    "A user names two platforms (\"Jobber vs Housecall Pro\") and wants a feature-by-feature and true-cost comparison from a source that sells neither.",
    "You need a platform's real capability matrix — which features are included, which cost extra, and which do not exist — rather than the vendor's own marketing copy.",
    "You need to know whether a platform is built for residential service calls or commercial contract work, and which trades it actually sells into.",
    "A user wants the scoring rubric behind a recommendation, because they need to audit or defend the choice rather than accept a ranked list."
  ],
  "discovery": {
    "openapi": "https://www.fieldservicescout.com/openapi.json",
    "function_calling_tools": "https://www.fieldservicescout.com/api/agent/v1/tools",
    "documentation": "https://www.fieldservicescout.com/docs",
    "llms_txt": "https://www.fieldservicescout.com/llms.txt",
    "llms_full_txt": "https://www.fieldservicescout.com/llms-full.txt",
    "agent_instructions": "https://www.fieldservicescout.com/agent-instructions.md",
    "markdown_content": "Send `Accept: text/markdown` to any page URL for a Markdown representation."
  },
  "operations": [
    {
      "operation_id": "listFieldServiceVendors",
      "method": "GET",
      "path": "/api/agent/v1/vendors",
      "summary": "List the field-service software platforms in the catalog",
      "when_to_use": "Use when the user asks what field-service/FSM software exists for a trade, or you need the valid vendor slugs before calling another operation.",
      "example_url": "https://www.fieldservicescout.com/api/agent/v1/vendors?trade=hvac&segment=residential"
    },
    {
      "operation_id": "getFieldServiceVendor",
      "method": "GET",
      "path": "/api/agent/v1/vendors/{slug}",
      "summary": "Get one platform's full profile",
      "when_to_use": "Use when the user names a specific platform and wants its features, plans, or pricing — or when you need to check whether one platform supports a particular capability.",
      "example_url": "https://www.fieldservicescout.com/api/agent/v1/vendors/jobber"
    },
    {
      "operation_id": "matchFieldServiceSoftware",
      "method": "GET",
      "path": "/api/agent/v1/match",
      "summary": "Rank platforms against one shop's requirements",
      "when_to_use": "Use when the user describes their shop — crew size, trade, budget, must-have capabilities — and wants a recommendation. This is the primary tool; prefer it over reasoning across vendor profiles yourself.",
      "example_url": "https://www.fieldservicescout.com/api/agent/v1/match?seats=8&segment=residential&trade=hvac&needs=scheduling,quickbooks&must_have=quickbooks&budget_per_tech=120"
    },
    {
      "operation_id": "estimateFieldServiceSoftwareCost",
      "method": "GET",
      "path": "/api/agent/v1/cost-estimate",
      "summary": "Model the true all-in cost of one or more platforms",
      "when_to_use": "Use when the user asks what a platform will actually cost, or wants two or more platforms' costs compared at their own crew size and card volume.",
      "example_url": "https://www.fieldservicescout.com/api/agent/v1/cost-estimate?vendors=jobber,housecall-pro&seats=8&monthly_card_volume=42000"
    },
    {
      "operation_id": "compareFieldServiceVendors",
      "method": "GET",
      "path": "/api/agent/v1/compare",
      "summary": "Compare two platforms feature-by-feature and on true cost",
      "when_to_use": "Use when the user names two platforms and asks which is better, or how they differ. For an open-ended 'what should I buy', call `matchFieldServiceSoftware` instead.",
      "example_url": "https://www.fieldservicescout.com/api/agent/v1/compare?vendors=jobber,housecall-pro&seats=8"
    },
    {
      "operation_id": "listAgentTools",
      "method": "GET",
      "path": "/api/agent/v1/tools",
      "summary": "List these tools as function-calling definitions, or as OpenAPI",
      "when_to_use": "Use once at the start of a session to discover what FieldServiceScout can answer, or to load these tools into a function-calling runtime automatically.",
      "example_url": "https://www.fieldservicescout.com/api/agent/v1/tools?format=openapi"
    }
  ]
}