Overview

FieldInsight Gateway

A scoped, audited interface to FieldInsight. JSON in, JSON out, one bearer key per integration.

Scoped by key

Your key sets exactly what you can see and do. Reads return only your own data; writes attach the right customer automatically. Nothing else to configure per request.

One call to create

Create a job — and its site inline via new_site — in a single request. Leave out job_type or end_time and sensible per-tenant defaults fill the gaps.

FieldInsight, smoothed over

Custom fields get readable names, jobs filter by open/closed state, and on-site photos & signatures come back as a completion-report PDF — the rough edges handled for you.

Predictable errors

Every failure is RFC 7807 problem+JSON: type classifies it, detail explains it. Every response carries an X-Request-Id (yours if you send one, else generated) — quote it when you need support.

Start here

1. Read Get started — the fastest path from a key to a working integration.
2. Skim Authentication, Rate limits, and Errors — the conventions reused everywhere.
3. Use the reference: List jobs, Get job, Create job, Update, Cancel.
4. Need the on-site photos and signatures? They come back as a PDF — see Job reports.
5. Subscribe to webhooks if you want push notifications rather than polling.