API Documentation — FieldFix Developer Reference

Quick Start

Get up and running in 5 minutes.

1 Get your API key

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

status	Filter by status: operational, needs_attention, overdue
type	Filter by equipment type 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

Track fuel, repairs, parts, and operating costs.

GET /machines/:id/expenses

Get expense history for a machine.

Query Parameters

category	Filter: fuel, maintenance, parts, repair, other
from	Start date (YYYY-MM-DD)
to	End date (YYYY-MM-DD)

POST /machines/:id/expenses

Log a new expense.

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 available as an npm package:

npm install @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
401	unauthorized	Missing or invalid API key
403	forbidden	API key doesn't have access
404	not_found	Resource not found
422	validation_error	Invalid request body
429	rate_limited	Too many requests
500	server_error	Internal server error

Rate Limits

Plan	Requests/minute	Requests/day
Free	30	1,000
Operator	60	10,000
Industry	120	100,000

Need Help?

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

Contact Support