v1 REST API

API Documentation

Integrate FieldFix fleet data into your applications, AI agents, or custom dashboards. Read and update machines, hours and service logs, read expenses, alerts and fleet totals, and run AI diagnoses. The API is part of FieldFix Pro.

Quick Start

Get up and running in 5 minutes.

1 Get your API key

On Pro, open app.fieldfix.ai/settings, tap New API key under API, and copy the key. It's only shown once.

2 Make your first request

curl https://app.fieldfix.ai/api/v1/machines \
  -H "Authorization: Bearer YOUR_API_KEY"

3 Parse the response

{ "machines": [ { "id": "abc123", "name": "2023 Bobcat T770", "make": "Bobcat", "model": "T770", "hours": 1247, "status": "operational" } ] }

Authentication

All API requests require a Bearer token in the Authorization header.

Header

Authorization: Bearer YOUR_API_KEY

Keep your API key secret. Don't expose it in client-side code or public repositories.

Base URL

https://app.fieldfix.ai/api/v1

Machines

Manage your fleet inventory.

GET /machines

List all machines in your fleet.

Query Parameters

statusFilter by status: operational, needs_attention, out_of_service
typeFilter by machine tag
GET /machines/:id

Get detailed information about a specific machine.

POST /machines/:id/hours

Update the current hour meter reading.

Service Logs

Track maintenance and service history.

GET /machines/:id/service

Get service history for a machine.

POST /machines/:id/service

Log a new service entry.

Expenses

Read a machine's fuel, parts, payment and other costs.

GET /machines/:id/expenses

Get expense history for a machine, with all-time, year-to-date and month-to-date totals and an all-time total for each category.

Query Parameters

periodall, ytd or mtd
limitNumber of expenses to return (default 50, max 100)

Alerts

Service reminders and maintenance alerts.

GET /alerts

Get all active alerts across your fleet.

AI Diagnostics

AI-powered troubleshooting and diagnostics.

POST /diagnostics

Get AI-powered diagnostic analysis for a machine issue.

Fleet Summary

Aggregate fleet statistics and cost analysis.

GET /fleet/summary

Get fleet-wide statistics.

GET /fleet/costs

Get cost analysis across your fleet.

MCP Integration

Connect FieldFix to AI agents using the Model Context Protocol (MCP).

What is MCP?

MCP is an open protocol that lets AI assistants securely access external data sources. With FieldFix's MCP integration, your AI can query fleet data directly — no dashboard required.

Example Queries

  • "What's my cost per hour on the T770?"
  • "When is the excavator due for service?"
  • "Show me all machines that need attention"
  • "What were my fuel costs last month?"

Setup

The FieldFix MCP server is on npm. Run it with:

npx fieldfix-mcp-server

See the GitHub repository for configuration details.

Error Handling

All errors return a consistent JSON structure.

Error Codes

HTTP Status Code Description
400invalid_body, invalid_json, missing_field, invalid_fieldThe request body is missing, isn't valid JSON, or a field is missing or wrong
401missing_auth, invalid_auth_format, invalid_key_format, invalid_key, key_revokedNo API key, a badly formed header or key, a key that doesn't match, or a revoked key
403subscription_requiredThe account isn't on FieldFix Pro
404not_foundMachine not found
429rate_limit_exceededDaily limit reached
500database_error, create_failed, update_failedSomething went wrong on our end

Rate Limits

Plan Requests a day
Pro10,000
Older Operator plan1,000

The count resets at midnight UTC. You can see today's count under Calls today in Settings. Past the limit, requests return 429 with rate_limit_exceeded until the next day.

POST /diagnostics also has a ceiling of 60 AI diagnoses a day, the same as the app.

Need Help?

Questions about the API? We're here to help.