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 Orders

Retrieve a paginated list of work orders for your company. Use the extensive query filters (status, dates, location, pay, template, etc.) and page/per_page to control pagination. Use columns/view to adjust which fields are returned.

GET
/api/rest/v2/workorders

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"
columns?string

Comma-separated list of column IDs to include in the response and their display order.

page?integer

Page number to retrieve

Default1
per_page?integer

Number of results per page

Default25
view?string

Shape of the response data. Use list for most integrations.

Default"list"
Value in"list" | "map" | "schedule" | "tiles" | "model"
sort?string

Column to sort results by.

Value in"id" | "title" | "schedule" | "status" | "pay" | "created_date"
order?string

Sort direction (ascending or descending)

Value in"asc" | "desc"
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.

f_?string

Pass with an empty value to clear all saved sticky filters for the current list. Useful when resetting state after filters were accidentally persisted by a previous request.

f_rating?string

(Buyer) Filter by assigned provider star rating. Accepts a single minimum value (e.g., 4.0) or an inclusive range (e.g., 3.5,5.0).

f_requests?boolean

(Buyer) Filter work orders with requests (true) or without requests (false)

f_has_counter_offer?boolean

(Buyer) Filter work orders with counter-offer requests of any type (schedule, expense, or pay change). Use true to include work with counter offers, false to exclude them

f_work_order_id?string

(Buyer) Filter by specific work order IDs. Accepts a single ID or comma-separated list.

f_min_hourly_rate?string

(Buyer) Filter by minimum hourly rate. Applies only to hourly or blended pay structures. Accepts a single minimum value (e.g., 50) or an inclusive range (e.g., 35,75).

f_fixed?string

(Buyer) Filter by minimum fixed rate. Applies to fixed or blended pay structures. Accepts a single minimum value (e.g., 250) or an inclusive range (e.g., 250,500).

f_device?string

(Buyer) Filter by minimum per-device rate. Applies only to device pay structures. Accepts a single minimum value (e.g., 25) or an inclusive range (e.g., 25,75).

f_pay?string

(Buyer) Filter by total payout. Matches work orders whose minimum or maximum payout meets or exceeds the value, or falls within the range. Applies to any pay structure.

f_template?string

(Buyer) Filter by template name or unique ID. Comma-separated list accepted. If a template name contains a comma, use its ID instead.

f_type_of_work?string

(Buyer) Filter by type-of-work name (e.g. Networking) or unique ID. Comma-separated list accepted.

f_time_zone?string

(Buyer) Filter by time zone. Accepts a time zone name (e.g., America/New_York), comma-separated list of zones, a UTC offset (e.g., -5), or an offset range (e.g., -4,-6).

f_mode?string

(Buyer) Filter by work order mode. Must be one of: 'managed', 'marketplace', or 'any'

Value in"managed" | "marketplace" | "any"
f_company?string

(Buyer) Filter by buyer company name (free-form text search) or company ID. Comma-separated list of IDs accepted.

f_manager?string

(Buyer) Filter by the company manager assigned to the work order. Accepts name (case-insensitive), email address, or user ID. Comma-separated list accepted.

f_client?string

(Buyer) Filter by client company name (case-insensitive) or client ID. Comma-separated list accepted.

f_project?string

(Buyer) Filter by project name (case-insensitive) or project ID. Comma-separated list accepted.

f_review_window?string

(Buyer) Filter to include only work orders that exceed the specified number of days, or the company's target approval days when no value is provided

f_network?string

(Buyer) Filter by one or more of your company's networks, by name or network ID. Comma-separated list accepted.

f_auto_dispatch?boolean

(Buyer) Filter by auto-dispatch status. true returns only auto-dispatched work orders; false excludes them.

f_service_schedule?string

(Buyer) Filter by service date. Single date (e.g., 2025-01-01) includes the whole day. Date range (e.g., 2025-01-01,2025-01-31) includes all dates in the range (inclusive). Values are assumed to be UTC and converted to the work order's local time for comparison.

f_created_date?string

(Buyer) Filter by creation date. Single date (e.g., 2025-01-01) includes the whole day. Date range (e.g., 2025-01-01,2025-01-31) includes all dates in the range (inclusive). Values are assumed to be UTC and converted to the work order's local time for comparison.

f_published?string

(Buyer) Filter by publication date. Single date (e.g., 2025-01-01) includes the whole day. Date range (e.g., 2025-01-01,2025-01-31) includes all dates in the range (inclusive). Values are assumed to be UTC and converted to the work order's local time for comparison.

f_routed?string

(Buyer) Filter by routing date. Single date (e.g., 2025-01-01) includes the whole day. Date range (e.g., 2025-01-01,2025-01-31) includes all dates in the range (inclusive). Values are assumed to be UTC and converted to the work order's local time for comparison.

f_published_or_routed?string

(Buyer) Filter by publication or routing date — whichever happened first. Single date (e.g., 2025-01-01) includes the whole day. Date range (e.g., 2025-01-01,2025-01-31) is inclusive.

f_work_done_done?string

(Buyer) Filter by the date the provider marked the work complete. Single date (e.g., 2025-02-01) includes the whole day. Date range (e.g., 2025-02-01,2025-02-28) is inclusive.

f_approved_cancelled_date?string

(Buyer) Filter by approval or cancellation date. Single date (e.g., 2025-01-01) includes the whole day. Date range (e.g., 2025-01-01,2025-01-31) includes all dates in the range (inclusive). Values are assumed to be UTC and converted to the work order's local time for comparison

f_confirmed?string

(Buyer) Filter by confirmation date. Single date (e.g., 2025-01-01) includes the whole day. Date range (e.g., 2025-01-01,2025-01-31) includes all dates in the range (inclusive). Values are assumed to be UTC and converted to the work order's local time for comparison

f_assigned_date?string

(Buyer) Filter by the date a provider was assigned. Single date (e.g., 2025-01-15) includes the whole day. Date range is inclusive.

f_location_ids?string

(Buyer) Filter by saved location ID or a comma-separated list of IDs.

f_location_group_ids?string

(Buyer) Filter by saved location group ID or a comma-separated list of IDs.

f_city?string

(Buyer) Filter by city name (case-insensitive). Comma-separated list accepted.

f_state?string

(Buyer) Filter by state name or abbreviation (case-insensitive). Comma-separated list accepted.

f_zip?string

(Buyer) Filter by ZIP or postal code (case-insensitive). Comma-separated list accepted.

f_country?string

(Buyer) Filter by country name (case-insensitive). Comma-separated list accepted.

f_flags?string

(Buyer) Filter by label/flag name or ID. Comma-separated list accepted. Pass an empty value to return only work orders with no flags assigned.

f_assigned_provider?string

(Buyer) Filter by one or more assigned provider user IDs. Comma-separated list accepted.

f_confirmation?string

(Buyer) Filter by confirmation status. Accepts one or more (comma-separated) of: 'unconfirmed', 'confirmed', 'readytogo', 'onmyway', 'checked-in', 'checked-out', 'in-progress'

f_fund?string

(Buyer) Filter by finance/funding account name or unique ID. Comma-separated list accepted.

f_search?string

(Buyer) Free-form keyword search across work order title, description, location, type of work, buyer name, and assigned provider. Case-insensitive.

acting_user_id?integer

ID of the user acting on behalf of another user

curl -X GET "https://api-sandbox.fndev.net/api/rest/v2/workorders"
{
  "actions": [],
  "metadata": {
    "total": 100,
    "page": 0,
    "pages": 5,
    "per_page": 20,
    "columns": "string_value",
    "view": "string_value",
    "sort": "string_value",
    "order": "string_value",
    "list": "string_value"
  },
  "params": [],
  "lists": [],
  "results": [],
  "loading_time": 0,
  "timings": [],
  "tags": [
    "tag1",
    "tag2"
  ],
  "custom_fields": [],
  "search_text": "string_value",
  "correlation_id": "string_value",
  "saved_filters": {
    "filter_id": "string_value",
    "template": "string_value",
    "user_id": "string_value",
    "filters": []
  }
}
{
  "status": 500,
  "message": "Operation successful."
}
{
  "status": 500,
  "message": "Operation successful."
}

Response Body

application/json

application/json

application/json

Last updated on

Update Work Order PUT

Previous Page

Create Work Order POST

Next Page

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