Start here

Get started

A scoped, audited interface to FieldInsight — JSON in, JSON out, one bearer key per integration. This page is the fastest path from a key to a working integration.

Try it live in the API Playground

The quickest way to learn the API. Paste your key, pick an endpoint, and send real requests against your own data — you’ll see the exact response, status, and headers for every endpoint, with no code to write.

Open the API Playground

Base URL

All v1 endpoints are rooted at:

https://gateway.innovateq.com.au/v1

The host is fixed for production — it is not per-tenant. Every request carries an Authorization: Bearer <key> header; there are no other tenant headers to set.

Your starting path

1
Get your API key
Your integration contact will issue a key (e.g. fi_pk_live_…). Treat it like a password — store it in a secret manager, never in source control. Each key carries its own scope; if one leaks we can rotate it with an overlap window so you don’t have an outage.
About keys & scopes
2
Confirm your key works
Make one read — listing your customers is the simplest check. A 200 with your customer(s) means you’re connected; 401 means the key is wrong or missing, and 403 no-scope means no customers are attached yet (tell us and we’ll finish setup).
Run it in the Playground
3
Discover the IDs you need
Sites, projects, job types, statuses and custom fields are referenced by ID. Resolve them once with the lookup endpoints and cache the results — they change rarely, and re-fetching them on every call will burn your rate-limit budget.
Browse the lookups
4
Read your jobs
List jobs with filters (by state, site, project, or an updated_at_from window for incremental sync), or fetch a single job by id. Responses carry only your scoped data.
See list & filters
5
Create a job
Request a new job — it lands unscheduled for your team to triage. project is required; you can reference an existing site or create one inline with new_site (its id comes back as site_id).
See the create contract
6
Get on-site media
Photos and signatures are delivered as the completion-report PDF FieldInsight generates — list a job’s reports, then resolve a short-lived PDF link.
See job reports
7
Operate reliably
Pace your calls to your per-key budget and handle the RFC 7807 error shape. Skim Rate limits and Errors before you go to production.
Rate limits & errors