Requirements

An active Farsight® admin account

Authorized API key

Limitations

For details on usage limits (like requests per hour/month), please refer API Usage Limits by Plan

Get A Paginated List of Work Orders (GET /v1/workorders)

Go to: https://api.farsight.gg/swagger/index.html#/WorkOrders/WorkOrders_GetWorkOrders

This API allows you to get a list of work orders from your Farsight® organisation.

The following parameters are used to filter, sort, and paginate the list of work orders returned in the response. All parameters are optional unless otherwise noted.

Input Parameter	Type	Require	Definition
SearchQuery	string	No	Work order Title or ID
status	string[array]	No	Work order status i.e Open, InProgress. OnHold, Closed
type	string[array]	No	Work order Type i.e. Inspection, PreventiveMaintenance, ReactiveMaintenance, Service, Troubleshooting, Other
source	string[array]	No	Work order source i.e. AssetManagement, Contract, Event, LegalObligation, Other
supervisor	string[array]	No	Supervisor organization email
assetId	Integer[array]	No	The IDs of the assets that have work orders
sort	string[array]	No	Fields used to sort the result. Composed by the name of the field followed by :asc or :desc. Example: id:asc.
Limit	integer	No	The number of items you want the API to return. It can range from 1 to 50 (Free) or 1 to 500 (Pro). The default value is set to 25.
Offset	integer	No	The index of the first item to return. Must be 0 or greater. It is set to 0 by default.

Note: Sortable properties are as follows - "work_order_number","status","type","source","scheduled_start_date","scheduled_end_date","actual_start_date","actual_end_date","supervisor","created_at"

Create a New Work Order (POST /v1/workorders)

Go to: https://api.farsight.gg/swagger/index.html#/WorkOrders/WorkOrders_GetWorkOrder

This API allows you to create a new work order for your Farsight organisation.All parameters are optional unless otherwise noted.

{ 
  "title": "string", 
  "description": "string", 
  "status": "Open", 
  "type": "Inspection", 
  "source": "AssetManagement", 
  "supervisorEmail": "string", 
  "allowedToStart": true, 
  "scheduledStartDate": "2025-11-13T16:14:22.947Z", 
  "scheduledEndDate": "2025-11-13T16:14:22.947Z", 
  "actualStartDate": "2025-11-13T16:14:22.947Z", 
  "actualEndDate": "2025-11-13T16:14:22.947Z", 
  "assetIds": [ 
    0 
  ], 
  "ticketIds": [ 
    0 
  ] 
}

Input Parameter	Type	Require	Definition
title	string	Yes	The title of the work order
description	string	No	The description of the work order. Limit: 1000 chars
status	string	No	The work order status e.g. Open, In Progress, On Hold, Closed
type	string	No	Work order Type i.e. Inspection, PreventiveMaintenance, ReactiveMaintenance, Service, Troubleshooting, Other
source	string	No	The source of the work order i.e. Asset Management, Legal Obligation, Contract, Event, Other
supervisorEmail	string	No	The organization email address of the supervisor
scheduledStartDate	string	No	The date the work ordere was supposed to start
scheduledEndDate	string	No	The date the work ordere was supposed to end
actualStartDate	string	No	The actual start date of the work order
actualEndDate	string	No	The actual end date of the order
AssetIds	Integer[array]	Yes	Comma-separated list of asset IDs associated with this work order
ticketIds	Integer[array]	No	Comma-separated list of ticket IDs associated with this work order

Get One Work Order (GET/v1/workorders/{id})

Go to: https://api.farsight.gg/swagger/index.html#/WorkOrders/WorkOrders_GetWorkOrder

This API allows you to get one work order from your Farsight organisation. All parameters are optional unless otherwise noted.

Input Parameter	Type	Require	Definition
id	integer	Yes	The ID of the work order

Edit One Order (POST /v1/workorders{is})

Go to: https://api.farsight.gg/swagger/index.html#/WorkOrders/WorkOrders_UpdateWorkOrder

This API allows you to create a new work order for your Farsight organisation.All parameters are optional unless otherwise noted.

{ 
  "title": "string", 
  "description": "string", 
  "status": "Open", 
  "type": "Inspection", 
  "source": "AssetManagement", 
  "supervisorEmail": "string", 
  "allowedToStart": true, 
  "scheduledStartDate": "2025-11-13T17:00:45.117Z", 
  "scheduledEndDate": "2025-11-13T17:00:45.117Z", 
  "actualStartDate": "2025-11-13T17:00:45.117Z", 
  "actualEndDate": "2025-11-13T17:00:45.117Z", 
  "assetIds": [ 
    0 
  ], 
  "ticketIds": [ 
    0 
  ] 
}

Input Parameter	Type	Require	Definition
title	string	Yes	The title of the work order
description	string	No	The description of the work order. Limit: 1000 chars
status	string	No	The work order status e.g. Open, In Progress, On Hold, Closed
type	string	No	Work Order Type i.e. Inspection, PreventiveMaintenance, ReactiveMaintenance, Service, Troubleshooting, Other
source	string	No	The source of the work order i.e. Asset Management, Legal Obligation, Contract, Event, Other
supervisorEmail	string	No	The organization email address of the supervisor
scheduledStartDate	string	No	The date the work ordered was supposed to start
scheduledEndDate	string	No	The date the work ordered was supposed to end
actualStartDate	string	No	The actual start date of the work order
actualEndDate	string	No	The actual end date of the order
AssetIds	Integer[array]	Yes	Comma-separated list of asset IDs associated with this work order
ticketIds	Integer[array]	No	Comma-separated list of ticket IDs associated with this work order

Delete One Work Order (DELETE /v1/workorders/{id})

Go to: https://api.farsight.gg/swagger/index.html#/WorkOrders/WorkOrders_DeleteWorkOrder

This API allows you to delete one work order from your Farsight organisation. All parameters are optional unless otherwise noted.

Input Parameter	Type	Require	Definition
id	integer	Yes	The ID of the work order

Farsight® Work Orders API