Getting started

API playground

Build and send real requests to the gateway with your own key — pick an endpoint, fill the fields, and inspect the live response.

Live console

Requests go to the real gateway using the key you paste below. Your key stays in your browser — it is sent only as the Authorization header and is never stored or shown in the generated cURL. Write requests (POST/PATCH) make real changes in FieldInsight within your scope; they need an explicit confirmation before sending.

API key

Stored only in this page's memory for the duration of your session.

Endpoint

Query parameters

Single-job lookup — returns just job N (if in scope).

site

FI site id — jobs at this site.

project

FI project id — jobs in this project.

status

FI status id.

external_id

number

Printable job number.

series_number

All visits in a series share this.

state

open = all open jobs (not paged); closed = recent closed only; needs open/closed configured in write-config.

start_time_from

start_time_to

updated_at_from

updated_at_to

page_size

cursor

Pagination cursor from a prior response.

Request

Pick an endpoint above to compose a request.