Skip to content

API reference

Enterprise feature

The REST API is available on Enterprise plans. Compare plans to find the right fit for your team.

The FSM Navigator Enterprise API gives you programmatic access to your field service data. Create jobs, query customer records, manage assets, and build integrations — all through a simple REST interface.

What you can do with the API

Capability Description
Job management Create, update, and track jobs from external systems
Customer sync Keep customer records in sync with your CRM or ERP
Asset tracking Read and update asset data, record meter readings
Automation Build workflows that trigger based on job events

Getting started

1. Create an API key

Navigate to Settings → API Keys in your FSM Navigator dashboard, then click Create API Key. Give it a descriptive name, select the scopes you need, and click Generate.

Save your key immediately

Your API key is displayed only once at creation. Copy it to a secure location before closing the dialog.

Full authentication guide

2. Make your first request

curl -X GET "https://fsmnavigator.com/api/v1/jobs" \
  -H "X-API-Key: YOUR_API_KEY"

import requests

response = requests.get(
    "https://fsmnavigator.com/api/v1/jobs",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch("https://fsmnavigator.com/api/v1/jobs", {
  headers: { "X-API-Key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(data);

3. Explore the endpoints

Browse the detailed endpoint documentation to see available filters, request bodies, and response schemas.

API sections

  • Authentication

    Create API keys, manage scopes, and configure IP whitelists.

    Authentication

  • Endpoints overview

    Quick-reference table of every available endpoint, method, and scope.

    Endpoints

  • Jobs API

    Create, update, list, and manage jobs programmatically.

    Jobs API

  • Customers API

    Manage customer records and locations via the API.

    Customers API

  • Assets API

    Track equipment, record meter readings, and manage asset data.

    Assets API

  • Rate limits

    Understand request throttling and best practices for high-volume usage.

    Rate limits

  • Error codes

    Troubleshoot API errors with the full error code reference.

    Error codes

  • Best practices

    Learn proven patterns for chaining requests, syncing data, and building reliable integrations.

    Best practices

Authentication at a glance

Every API request requires a valid API key sent in the X-API-Key header:

X-API-Key: YOUR_API_KEY

Keys use the format fsm_live_ or fsm_test_ followed by a unique string. Manage your keys in Settings → API Keys.