Introduction

Welcome to the FieldInsight Public API, your gateway to integrating with our powerful field service management platform. This API allows developers to programmatically access and manage data from FieldInsight, including job scheduling, customer information, timesheets, and more.

Built on RESTful principles and secured through HTTPS, the FieldInsight API ensures data privacy and integrity.

Base URL

All URLs referenced in the documentation have the following base URL: https://app.fieldinsight.com/public-api/

Authentication Models

The FieldInsight Public API supports two authentication methods:

OAuth 2.0

Personal API Keys

Each method is designed for different use cases and levels of complexity.

OAuth 2.0 (Recommended for Integrations)

OAuth 2.0 is a secure, industry-standard authentication protocol that allows applications to access FieldInsight on behalf of a user without sharing their password.

When to use OAuth 2.0

Use OAuth 2.0 when:

You are building an integration used by multiple customers

You need users to grant access to their FieldInsight accounts

You are developing a public or third-party application

How it works (simplified)

The user is redirected to FieldInsight to log in

The user grants permission to your application

Your application receives an access token

The access token is used to make API requests

Setup

To use OAuth 2.0, you must register an application in FieldInsight:

OAuth App Registration: https://app.fieldinsight.com/dev-access/

⚠️ App registration is only required for OAuth 2.0. It is not needed when using Personal API Keys.

Example Use Case

A SaaS platform that integrates with FieldInsight to:

Import customer and job data

Push updates back into FieldInsight

Each customer connects their own FieldInsight account via OAuth, without sharing credentials.

Personal API Keys (Best for Internal Use)

Personal API Keys are simple tokens that authenticate requests on behalf of a single FieldInsight user.

When to use API Keys

Use API keys when:

You are building internal tools

The integration is used by a single organisation

You control both the client and the usage environment

How it works

A user generates an API key in FieldInsight

The key is included in API requests

Requests are authenticated as that user

Setup

API keys can be generated and managed here:

Personal API Key Configuration: https://app.fieldinsight.com/scheduler/settings/#app=personal-api-keys

Example Use Case

An internal script that:

Automatically creates jobs from emails

Updates job statuses based on internal systems

Since the script runs within a trusted environment, a single API key is sufficient.

Choosing the Right Authentication Method

Scenario	Recommended Method
Public integration for multiple customers	OAuth 2.0
Third-party SaaS application	OAuth 2.0
Internal automation tool	API Key
Single-organisation integration	API Key

Getting Started

To start using the FieldInsight Public API:

Review the API documentation

Determine your use case

Choose the appropriate authentication method

Complete setup:

Generate a Personal API Key

Start making API requests

Base URL#

Authentication Models#

OAuth 2.0 (Recommended for Integrations)#

When to use OAuth 2.0#

How it works (simplified)#

Setup#

Example Use Case#

Personal API Keys (Best for Internal Use)#

When to use API Keys#

How it works#

Setup#

Example Use Case#

Choosing the Right Authentication Method#

Getting Started#

Base URL

Authentication Models

OAuth 2.0 (Recommended for Integrations)

When to use OAuth 2.0

How it works (simplified)

Setup

Example Use Case

Personal API Keys (Best for Internal Use)

When to use API Keys

How it works

Setup

Example Use Case

Choosing the Right Authentication Method

Getting Started