Field NationDeveloper Platform
Field NationDeveloper Platform
Overview

Work Orders

List Work Order Lists GETTrigger Smart Dispatch POSTDelete Work Order DELETEGet Work Order Details GETUpdate Work Order PUTList Work Orders GETCreate Work Order POST

Resources

BasicsCore operations

List Work Order Lists


Return saved work order lists (e.g., tabs or saved searches) and their current counts, honoring the list and sticky parameters.

GET
/api/rest/v2/workorders/lists

Authorization

access_token
access_token<token>

OAuth 2.0 Access Token

In: query

Query Parameters

list?string

Scopes results to a specific stage of the work order lifecycle — equivalent to selecting a tab in the Field Nation UI. Always include this parameter explicitly; if omitted, the API falls back to the last saved sticky state, which can silently change results between requests.

Default"workorders_all"
Value in"workorders_in_flight" | "workorders_draft" | "workorders_published_routed" | "workorders_assigned" | "workorders_problem" | "workorders_work_done" | "workorders_approved" | "workorders_all"
sticky?boolean

When true, saves the current filters, columns, and sort to be re-applied on future requests where those parameters are omitted. Saves per authenticated user, per list. Always pass false in integrations to keep requests self-contained.

Defaultfalse
stickyName?string

Named sticky context to apply or save (e.g. mobile). Allows multiple independent sticky states per authenticated user.

curl -X GET "https://api-sandbox.fndev.net/api/rest/v2/workorders/lists"
[]
{
  "status": 500,
  "message": "Operation successful."
}
{
  "status": 500,
  "message": "Operation successful."
}

Response Body

application/json

application/json

application/json

Last updated on

Generate Access Token POST

Previous Page

Trigger Smart Dispatch POST

Next Page

curl -X GET "https://api-sandbox.fndev.net/api/rest/v2/workorders/lists"