Frontline EHS API Guide

An API (Application Programming Interface) is a secure way for two systems to “talk” to each other.

For example, a GPS app on your phone shows live traffic because it connects to a traffic data system through an API. The app requests information, and the system responds with data your phone can display.

About Frontline EHS API's:

Frontline Data Solutions provides a RESTful API that allows clients to:

• Retrieve site data programmatically

• Integrate with external systems (e.g., BI tools, reporting systems)

• Build custom dashboards and data visualizations

• Automate reporting processes

All API responses are returned in JSON format, which is a standard format used by most reporting and analytics tools.

Getting Started:

Step 1: Request an API Key

To access the API, you must first obtain an API Key.

Email: support@fldata.com

Frontline Support will generate your API Key and provide any necessary guidance.

Step 2: Locate Your API Key (Admins Only)

Site Administrators can access API key information within the application:

LMS > Settings > EHS API

If you do not see this option, contact Frontline Support.

Step 3: Base URL & Documentation

Base API URL: https://ehsapi.fldata.com/api/v1

Interactive API Documentation (Swagger): https://ehsapi.fldata.com/swagger/index.html

• • View available endpoints

  • See required parameters

  • Test API calls directly in your browser

Authorizing Your API Requests

All API requests require authentication. You can authenticate in one of two ways:

Option 1 – Query Parameter (Common for Browser Testing)

Add your API key directly to the URL:

https://ehsapi.fldata.com/api/v1/Divisions/?ApiKey=YOUR_API_KEY

This method is commonly used for testing or quick data pulls.

Option 2 – Authorization Header (Recommended for Integrations)

Include the following header in your API request:

Authorization: Bearer YOUR_API_KEY

This method is preferred for system-to-system integrations.

Making API Calls & Using Filters

The Frontline API allows you to filter results directly in the URL. This makes it possible to test requests in a standard web browser or configure filters in reporting tools and integrations.

How Filtering Works

All filters are passed through the URL query string using the filter= parameter.

Filter Structure

Each filter contains three parts, separated by pipes (|): FieldName | Operator | Value

Format: 

https://<base_api_url>/<endpoint>?apikey=<apikey>&filter-<field>|<operator>|<value>

Example: 

https://ehsapi.fldata.com/api/v1/users?apikey=12345&filter=lastname|eq|Smith

This request returns all users with the last name Smith.

Multiple Filters

Multiple filters are separated by semi-colons (;).

When more than one filter is used, they are automatically combined using AND logic.

Format:

filter=<field1>|<operator>|<value1>;<field2>|<operator>|<value2>

Example:

https://ehsapi.fldata.com/api/v1/users?apikey=12345&filter=lastname|eq|Smith;birthday|lt|2001-01-01

If today’s date were 2022-01-01, this request would return:

Users with the last name Smith AND who are 21 years or older

Available Operators

The following operators are supported:

Additional Examples

• Find users with a first name of John or Jane
  • filter=firstname|in|John,Jane
• Find users whose first name is NOT John or Jane
  • filter=firstname|notin|John,Jane
• Find MOCs completed in Q1 of 2022
  • filter=completedOn|gte|2022-01-01;completedOn|lte|2022-03-31;status|eq|closed

Key Points to Remember

• Filters are always passed in the URL query string.

• Multiple filters are separated by semicolons.

• Multiple filters are always combined using AND logic.

• Values for in and notin must be comma-separated.

• Date formats should follow standard ISO format: YYYY-MM-DD.