Skip to content

API endpoints overview

Enterprise feature

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

This page provides a quick-reference table of every available endpoint in the FSM Navigator Enterprise API. Click any endpoint name to jump to its detailed documentation.

Base URL

All API requests use the following base URL:

https://fsmnavigator.com/api/v1

Available endpoints

Jobs

Method Path Description Required scope
GET /api/v1/jobs List all jobs with optional filters jobs:read
GET /api/v1/jobs?id={id} Retrieve a single job by ID jobs:read
POST /api/v1/jobs Create a new job jobs:write
PUT /api/v1/jobs?id={id} Update an existing job jobs:write
PATCH /api/v1/jobs?id={id} Update a job's status jobs:write

Full Jobs API reference

Customers

Method Path Description Required scope
GET /api/v1/customers List customers customers:read
GET /api/v1/customers?id={id} Retrieve a single customer customers:read
GET /api/v1/customers?id={id}&include=locations Get customer with embedded locations customers:read
POST /api/v1/customers Create a customer customers:write
PUT /api/v1/customers?id={id} Update a customer customers:write

Customer locations

Method Path Description Required scope
GET /api/v1/customers?id={id}&locations=1 List locations for a customer customers:read
POST /api/v1/customers?id={id}&locations=1 Create a location customers:write
PUT /api/v1/customers?id={id}&locations=1&location_id={loc_id} Update a location customers:write

Full Customers API reference

Assets

Method Path Description Required scope
GET /api/v1/assets List assets assets:read
GET /api/v1/assets?id={id} Retrieve a single asset assets:read
POST /api/v1/assets Create an asset assets:write
PUT /api/v1/assets?id={id} Update an asset assets:write
PATCH /api/v1/assets?id={id} Update asset status assets:write

Asset sub-resources

Method Path Description Required scope
GET /api/v1/assets?id={id}&sub=service_history Get service history assets:read
POST /api/v1/assets?id={id}&sub=service Create a service record assets:service
POST /api/v1/assets?id={id}&sub=meter_reading Submit a meter reading assets:meter
POST /api/v1/assets?id={id}&sub=transfer Transfer an asset assets:transfer

Full Assets API reference

Inventory

Method Path Description Required scope
GET /api/v1/inventory List inventory items inventory:read
GET /api/v1/inventory?id={id} Retrieve a single item inventory:read
POST /api/v1/inventory Create an item inventory:write
PUT /api/v1/inventory?id={id} Full update an item inventory:write
PATCH /api/v1/inventory?id={id} Partial update an item inventory:write

Inventory sub-resources

Method Path Description Required scope
GET /api/v1/inventory?id={id}&sub=stock Get item stock levels inventory:read
GET /api/v1/inventory?id={id}&sub=transactions Get item transactions inventory:read
POST /api/v1/inventory?id={id}&sub=adjust Adjust stock level inventory:write
POST /api/v1/inventory?sub=transfer Transfer stock inventory:transfer
GET /api/v1/inventory?sub=locations List locations inventory:read
GET /api/v1/inventory?sub=locations&location_id={id} Get a location inventory:read
GET /api/v1/inventory?sub=low-stock Low stock alerts inventory:read

Full Inventory API reference

Technicians

Method Path Description Required scope
GET /api/v1/technicians List technicians technicians:read
GET /api/v1/technicians?id={id} Get a single technician technicians:read

Read-only

The Technicians API is read-only. Technician management is handled through the FSM Navigator dashboard.

Full Technicians API reference

API health

Method Path Description Required scope
GET /api/v1/ API information and version None
GET /api/v1/?action=health Health check None

Health endpoints do not require authentication and can be used for uptime monitoring.

Request format

  • All POST and PUT requests must send a Content-Type: application/json header.
  • All requests must include a valid API key in the X-API-Key header. See Authentication.
  • Query parameters use standard URL encoding.

Response format

The API uses two response patterns depending on the operation type.

List responses return a data array with pagination:

{
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 42,
    "total_pages": 1
  },
  "request_id": "unique_id"
}

Mutation responses (create, update, status change) return a success flag:

{
  "success": true,
  "message": "Resource created successfully",
  "data": { ... },
  "request_id": "unique_id"
}

Error responses include an error code and message:

{
  "success": false,
  "error": "error_code",
  "message": "Human-readable description of the error"
}

See Error codes for the full error reference.

Pagination

List endpoints support pagination with these query parameters:

Parameter Type Default Description
page integer 1 Page number
per_page integer 50 Results per page (max 100)

Paginated responses include a pagination object:

{
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 142,
    "total_pages": 6
  },
  "request_id": "unique_id"
}

Filtering and sorting

Most list endpoints accept filter parameters specific to the resource. Common patterns include:

  • Status filter — ?status=Pending
  • Date range — ?start_date=2026-01-01&end_date=2026-01-31
  • Sort order — ?sort=created_at&order=desc

Refer to each endpoint's detailed page for the full list of supported filters.

Rate limits

All API endpoints are subject to rate limiting. When you exceed the allowed request rate, the API returns HTTP 429 Too Many Requests with a Retry-After header. See Rate limits for best practices.