Use GET /workorders to find, filter, and sort your work orders by status, date, location, assignment, pay, and more.
GET /workorders is your main tool for retrieving work orders. Think of it like the Field Nation dashboard's search and filter panel — but as an API. You describe what you want using query parameters, and the API returns exactly that.
GET /workordersA list scopes your results to a stage of the work order lifecycle — the same as clicking a tab in the Field Nation UI (e.g., "Assigned" or "Draft"). Each list pre-applies its own base filters, so you always start from the right context.
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_assigned&access_token=YOUR_TOKEN"Layer any number of f_* parameters to narrow results. Filters combine with AND logic — every filter you add further reduces the result set.
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_assigned&f_state=TX&f_service_schedule=2026-01-01,2026-01-31&access_token=YOUR_TOKEN"Use page and per_page to work through large result sets. The response always tells you the total count and how many pages exist.
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_state=TX&page=2&per_page=50&access_token=YOUR_TOKEN"A list scopes your results to a specific stage of the work order lifecycle. Every request should include a list parameter — without it, the API may fall back to a previously saved state and return unexpected results.
| Value | Label | What's in it |
|---|---|---|
workorders_in_flight | In-Flight | Active work orders that are underway or confirmed |
workorders_draft | Draft | Unpublished work orders still being configured |
workorders_published_routed | Published / Routed | Published or routed to providers, not yet assigned |
workorders_assigned | Assigned | Work orders with a confirmed provider assignment |
workorders_problem | Issue | Work orders with a reported problem |
workorders_work_done | Done | Provider has marked the work complete |
workorders_approved | Approved | You have approved the completed work |
workorders_all | All | Every non-archived work order (API default) |
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_assigned&sticky=false&access_token=YOUR_TOKEN"Integration tip: Always pass list explicitly in your integration. If omitted, the API uses the last saved list from your account's sticky state, which can silently change the result set between requests.
Not sure of the exact work order details? Use f_search to run a free-form keyword search across multiple fields at once.
Prop
Type
Description
?f_searchstringFree-form keyword search across work order title, description, location, type of work, buyer name, and assigned provider. Case-insensitive.
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_search=network+switch+installation&sticky=false&access_token=YOUR_TOKEN"All filter parameters are prefixed with f_ and can be combined freely. The sections below cover the most commonly used filters, grouped by what they filter.
Use these to find specific work orders by ID, template, type, or label.
Prop
Type
Description
?f_work_order_idstringOne or more specific work order IDs. Accepts a single ID or a comma-separated list.
?f_templatestringFilter by template name or unique ID. Comma-separated list accepted. If a template name contains a comma, use its ID instead.
?f_type_of_workstringFilter by type-of-work name (e.g. Networking) or unique ID. Comma-separated list accepted.
?f_flagsstringFilter by label/flag name or ID. Comma-separated list accepted. Pass an empty value to return only work orders with no flags assigned.
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_work_order_id=1001,1002,1003&sticky=false&access_token=YOUR_TOKEN"curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_template=55&sticky=false&access_token=YOUR_TOKEN"curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_type_of_work=Networking,Cabling&sticky=false&access_token=YOUR_TOKEN"# Returns only work orders with no flags assigned
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_flags=&sticky=false&access_token=YOUR_TOKEN"Use these to filter by who is assigned, how they were dispatched, or whether there are outstanding requests or counter-offers.
Prop
Type
Description
?f_assigned_providerstringFilter by one or more assigned provider user IDs. Comma-separated list accepted.
?f_auto_dispatchbooleantrue returns only auto-dispatched work orders; false excludes them.
?f_requestsbooleantrue returns work orders with pending provider requests; false returns those without any.
?f_has_counter_offerbooleantrue returns work orders with active counter-offers (schedule, expense, or pay change); false returns those without.
?f_ratingstringFilter by the assigned provider's star rating. Accepts a single minimum value (e.g. 4.0, meaning 4.0 or higher) or an inclusive range (e.g. 3.5,5.0).
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_assigned&f_assigned_provider=12345&sticky=false&access_token=YOUR_TOKEN"curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_published_routed&f_requests=true&sticky=false&access_token=YOUR_TOKEN"curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_has_counter_offer=true&sticky=false&access_token=YOUR_TOKEN"# Work orders assigned to providers rated 4.0 stars or higher
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_rating=4.0&sticky=false&access_token=YOUR_TOKEN"Filter by internal structure — the company, manager, client, project, network, or funding account associated with a work order.
Prop
Type
Description
?f_companystringFilter by buyer company name (free-form text search) or company ID. Comma-separated list of IDs accepted.
?f_managerstringFilter by the company manager assigned to the work order. Accepts name (case-insensitive), email address, or user ID. Comma-separated list accepted.
?f_clientstringFilter by client company name (case-insensitive) or client ID. Comma-separated list accepted.
?f_projectstringFilter by project name (case-insensitive) or project ID. Comma-separated list accepted.
?f_networkstringFilter by one or more of your company's networks, by name or network ID.
?f_fundstringFilter by finance/funding account name or unique ID. Comma-separated list accepted.
# Work orders for a specific client under a project
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_client=20&f_project=55&sticky=false&access_token=YOUR_TOKEN"
# Work orders managed by a specific person
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_manager=jane@acme.com&sticky=false&access_token=YOUR_TOKEN"
# Work orders funded by a specific account
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_fund=10&sticky=false&access_token=YOUR_TOKEN"Filter work orders by when key events occurred. All date filters follow the same format.
Date format: Dates are accepted as YYYY-MM-DD for a full calendar day, or YYYY-MM-DD,YYYY-MM-DD for an inclusive range. All values are treated as UTC and converted to each work order's local time zone for comparison.
Prop
Type
Description
?f_service_scheduleYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDWhen the work is scheduled to happen (the service date).
?f_created_dateYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDDate the work order was created.
?f_publishedYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDDate the work order was published.
?f_routedYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDDate the work order was routed to a provider.
?f_published_or_routedYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDDate the work order was either published or routed — whichever happened first.
?f_assigned_dateYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDDate a provider was assigned.
?f_work_done_doneYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDDate the provider marked the work complete.
?f_approved_cancelled_dateYYYY-MM-DD or YYYY-MM-DD,YYYY-MM-DDDate the work order was approved or cancelled.
# Work orders scheduled in January 2026
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_service_schedule=2026-01-01,2026-01-31&sticky=false&access_token=YOUR_TOKEN"# Work orders created on a specific day
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_created_date=2026-03-01&sticky=false&access_token=YOUR_TOKEN"
# Work orders created in Q1 2026
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_created_date=2026-01-01,2026-03-31&sticky=false&access_token=YOUR_TOKEN"# Work orders approved or cancelled in Q1 2026
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_approved_cancelled_date=2026-01-01,2026-03-31&sticky=false&access_token=YOUR_TOKEN"# Work orders marked complete in February 2026
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_work_done_done=2026-02-01,2026-02-28&sticky=false&access_token=YOUR_TOKEN"Filter by the physical location of the work order. Use geographic fields for broad filtering, or saved location IDs for precise, pre-defined sites.
Prop
Type
Description
?f_citystringCity name (case-insensitive). Comma-separated list accepted.
?f_statestringState name or abbreviation (case-insensitive). Comma-separated list accepted.
?f_zipstringZIP or postal code (case-insensitive). Comma-separated list accepted.
?f_countrystringCountry name (case-insensitive). Comma-separated list accepted.
?f_time_zonestringTime zone name (e.g. America/New_York), a comma-separated list of zones, a UTC offset (e.g. -5), or an offset range (e.g. -4,-6).
?f_location_idsstringFilter by saved location ID or a comma-separated list of IDs.
?f_location_group_idsstringFilter by saved location group ID or a comma-separated list of IDs.
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_state=TX,CA&sticky=false&access_token=YOUR_TOKEN"curl "https://api.fieldnation.com/api/rest/v2/workorders?f_city=Austin,Dallas&sticky=false&access_token=YOUR_TOKEN"curl "https://api.fieldnation.com/api/rest/v2/workorders?f_zip=78701,78702&sticky=false&access_token=YOUR_TOKEN"# One or more specific saved locations
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_location_ids=42,43&sticky=false&access_token=YOUR_TOKEN"
# A saved location group
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_location_group_ids=7&sticky=false&access_token=YOUR_TOKEN"# By IANA time zone name
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_time_zone=America/Chicago&sticky=false&access_token=YOUR_TOKEN"
# By UTC offset range (covers Central and Eastern)
curl "https://api.fieldnation.com/api/rest/v2/workorders?f_time_zone=-5,-6&sticky=false&access_token=YOUR_TOKEN"Filter by how much a work order pays. Accepts a single minimum value or an inclusive range.
Prop
Type
Description
?f_paystringFilter 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_min_hourly_ratestringFilter by minimum hourly rate. Applies only to hourly or blended pay structures.
# Work orders paying between $100 and $500 total
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_pay=100,500&sticky=false&access_token=YOUR_TOKEN"
# Work orders paying at least $250 total
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_pay=250&sticky=false&access_token=YOUR_TOKEN"
# Work orders with an hourly rate of at least $50/hr
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_min_hourly_rate=50&sticky=false&access_token=YOUR_TOKEN"Prop
Type
Description
?pageintegerPage number to retrieve.
?per_pageintegerNumber of results per page.
# Fetch the second page with 50 results per page
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&page=2&per_page=50&sticky=false&access_token=YOUR_TOKEN"The response metadata object always includes total, page, pages, and per_page so you know how many more pages remain.
Prop
Type
Description
?sortstringColumn to sort results by. Valid values: id, title, schedule, status, pay, created_date.
?order"asc" | "desc"Sort direction.
# Soonest service date first
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&sort=schedule&order=asc&sticky=false&access_token=YOUR_TOKEN"
# Most recently created first
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&sort=created_date&order=desc&sticky=false&access_token=YOUR_TOKEN"
# Highest paying first
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&sort=pay&order=desc&sticky=false&access_token=YOUR_TOKEN"Real-world examples combining multiple parameters.
All open work orders in Texas, sorted by service date:
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_state=TX&sort=schedule&order=asc&sticky=false&access_token=YOUR_TOKEN"Work orders created in Q1 2026 for a specific project:
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_project=55&f_created_date=2026-01-01,2026-03-31&sticky=false&access_token=YOUR_TOKEN"Published work orders with pending provider requests, page 2:
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_published_routed&f_requests=true&page=2&per_page=25&sticky=false&access_token=YOUR_TOKEN"All work orders assigned to a specific provider:
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_assigned&f_assigned_provider=12345&sticky=false&access_token=YOUR_TOKEN"Keyword search across all draft work orders:
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_draft&f_search=fiber+optic&sticky=false&access_token=YOUR_TOKEN"Work orders for a specific client, filtered by pay range:
curl "https://api.fieldnation.com/api/rest/v2/workorders?list=workorders_all&f_client=20&f_pay=100,500&sticky=false&access_token=YOUR_TOKEN"A successful 200 response always includes these top-level fields.
{
"results": [...],
"metadata": {
"total": 142,
"page": 1,
"pages": 6,
"per_page": 25,
"sort": "schedule",
"order": "asc",
"list": "workorders_all",
"available_filters": [...],
"available_columns": [...]
},
"lists": [...],
"saved_filters": [...]
}Last updated on