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

Get cached work order count if available to avoid database load

columns?string

Specify the columns and their display order

page?integer

Page number to retrieve

per_page?integer

Number of results per page

view?string

View style that determines how the response data is formatted. Use 'list' for most cases; other options include 'map', 'schedule', 'tiles', etc.

sort?string

Column ID to sort results by

order?string

Sort direction (ascending or descending)

Value in"asc" | "desc"
sticky?string

Preserve filters between page loads

stickyName?string

Name of the sticky filter to fetch

f_?string

Clear all active filters

f_max_approval_time?integer

(Provider) Filter work orders where the company's maximum approval day target is less than or equal to the specified number of days

f_rating?string

(Provider) Filter by buyer star rating. (Buyer) Filter by assigned provider star rating. Value can be a single number (e.g., 3.5) that must be met or exceeded, or an inclusive range (e.g., 3.5,5.0)

f_flightboard_tomorrow?boolean

(Provider) Filter for work orders displayed on the confirm tomorrow work screen

f_requests?boolean

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

f_counter_offers?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/Provider) Filter by specific work order IDs (comma-separated)

f_hourly?string

(Buyer/Provider) Filter by minimum hourly rate. Applies to hourly or blended pay structures. Can be a single value (e.g., 50) that must be met or exceeded, or an inclusive range (e.g., 35,75)

f_fixed?string

(Buyer/Provider) Filter by minimum fixed rate. Applies to fixed or blended pay structures. Can be a single value (e.g., 250) that must be met or exceeded, or an inclusive range (e.g., 250,500)

f_device?string

(Buyer/Provider) Filter by minimum per-device rate. Applies only to device pay structures. Can be a single value (e.g., 250) that must be met or exceeded, or an inclusive range (e.g., 250,500)

f_pay?string

(Buyer/Provider) Filter by payout amount. Can be a single value (e.g., 250) where minimum or maximum payout must meet or exceed, or an inclusive range (e.g., 250,500) where payout falls within the range

f_templates?string

(Buyer) Filter work orders created using specific templates. Can be provided by template name or unique ID. Accepts a single value or comma-separated list. If the template name contains a comma, use the unique identifier instead

f_type_of_work?string

(Buyer/Provider) Filter by type of work. Can be provided as full description (e.g., Networking) or unique identifier (e.g., 40). Accepts a single value or comma-separated list. If descriptions contain commas, use unique identifiers

f_time_zone?string

(Buyer/Provider) Filter by time zone. Can be provided as time zone name (e.g., America/New_York), comma-separated list of time zones, time zone offset (e.g., -5), or range of offsets (e.g., -4,-6)

f_mode?string

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

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

(Buyer/Provider) Filter by buyer company. Can be provided as free-form text to search by name (e.g., 'acme'), company unique identifier (e.g., '50'), or comma-separated list of identifiers (e.g., 50,51,52)

f_worked_with?string

(Provider) Filter to include only work orders from companies that you or your vendor/service company have previously worked with

f_manager?string

(Buyer) Filter by company manager. Can be provided as name (case-insensitive), email, unique ID, or comma-separated list of any of these

f_client?string

(Buyer) Filter by client company. Can be provided as name (case-insensitive), unique ID, or comma-separated list of either

f_project?string

(Buyer) Filter by project. Can be provided as name (case-insensitive), unique ID, or comma-separated list of either

f_approval_window?string

(Provider) Filter to include only companies whose target approval days are equal to or less than the specified value (e.g., 2) or within a given range (e.g., 1,3)

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. Requires Field Nation Complete feature to enable new networks. Networks can be provided as comma-separated list of names (e.g., Field Nation) or unique IDs

f_auto_assign?string

(Buyer) Filter by auto-assignment status. Use true to include only auto-assigned/dispatched work orders, false to exclude them

f_schedule?string

(Buyer/Provider) 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?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/Provider) 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/Provider) 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_routed?string

(Buyer/Provider) Filter by publication or 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_completed?string

(Buyer/Provider) Filter by completion 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_approved_cancelled_date?string

(Buyer/Provider) 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/Provider) 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?string

(Buyer/Provider) Filter by assignment 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_saved_location?string

(Buyer) Filter by saved location. Can be provided as location name (e.g., Acme store #1) or unique identifier. Accepts a single value or comma-separated list. If the name contains a comma, use unique identifiers

f_saved_location_group?string

(Buyer) Filter by saved location group. Can be provided as group name (e.g., Acme stores) or unique identifier. Accepts a single value or comma-separated list. If the name contains a comma, use unique identifiers

f_city?string

(Buyer/Provider) Filter by city name (case-insensitive). Accepts a single city or comma-separated list of cities

f_state?string

(Buyer/Provider) Filter by state or province (case-insensitive). Accepts a single state or comma-separated list of states

f_postal_code?string

(Buyer/Provider) Filter by postal or ZIP code (case-insensitive). Accepts a single code or comma-separated list of codes

f_country?string

(Buyer/Provider) Filter by country (case-insensitive). Accepts a single country or comma-separated list of countries

f_flags?string

(Buyer) Filter by work order flags. Can be provided as flag name (e.g., Late) or unique ID. Accepts a single value or comma-separated list. If empty, includes only work orders with no flags

f_assignment?string

(Buyer/Provider) Filter by assignment type. Must be one of: 'vendor', 'service_company', 'provider', 'any', or a single provider unique ID, or comma-separated list of provider IDs

f_confirmation?string

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

f_financing?string

(Buyer) Filter by financing account. Can be provided as account name or unique identifier. Accepts a single value or comma-separated list

f_location_radius?string

(Provider) Filter work orders within a geographic radius. Format: '<search_string>,<radius_in_miles>'. Search string can be an address, left blank to use provider's home address, or coordinates as ','. If radius is omitted, defaults to 60 miles

f_remote_work?boolean

(Provider) Filter to exclude all work orders with an onsite location when set to true

f_search?string

Keyword search (case-insensitive) across title, description, location, type of work, buyer, assigned provider, and other criteria

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"