Work Order APIs
A Work Order is a record created for executing a customer service request.
List Work Orders
Purpose
To fetch the list of all available work orders. The records fetched will be sorted by Created Time in descending order (recent ones first).
Request URL
https://fsm.zoho.com/fsm/v1/Work_Orders
Request Method
GET
Scope
scope=ZohoFSM.modules.WorkOrders.READ
Query Parameters
| Parameter Name | Data Type | Description | Possible Values |
| page (optional) | Integer | The page from which you want to fetch the records. The default value is 1. | Positive Integer values only |
| per_page (optional) | Integer | The number of records you want to fetch in a page. The default value is 200. | Positive Integer values only |
Sample Request
Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Work_Orders' \
--header 'Authorization: Zoho-oauthtoken 1000.3xxxxxxxxx.xxxxxxxxxxxxx0e'Sample Response
Copied{
"data": [
{
"Owner": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Estimate": null,
"Company": null,
"Email": "lucy.robins@zylker.com",
"Discount": null,
"$currency_symbol": "$",
"Cancellation_Reason": null,
"Config": "{\"sales_tax_type\":\"exclusive\",\"tax_rounding_type\":\"not_configured\",\"Type\":\"32\",\"is_discount_before_tax\":true,\"is_inclusive_tax\":false,\"is_discount_tax_inclusive\":false,\"discount_type\":\"item_level\",\"is_sales_inclusive_tax_enabled\":false,\"transaction_rounding_type\":\"no_rounding\",\"Tax_Details\":{\"Tax_Percentage\":6.25,\"Tax_Id\":\"2908070000000092001\",\"taxFromModule\":\"Addresses\",\"Tax_Name\":\"IllinoisExciseTax\",\"Taxable\":true}}",
"Closed_Time": null,
"Cancelled_Or_Terminated_Time": null,
"Dispatcher": {
"name": "Tracy Pollan",
"id": "1011000000139328"
},
"Name": "WO21",
"Tax_Amount": 10.62,
"Invalid_Data": false,
"Modified_By": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Exchange_Rate": 1,
"Cancellation_Message": null,
"Phone": null,
"Currency": "USD",
"Service_Address": {
"Service_Latitude": 40.798554,
"Service_Street_1": "2627 W Townline Rd,",
"Service_State": "Illinois",
"Service_Zip_Code": "61615",
"name": "AD-8",
"id": "1011000000156377",
"Service_Longitude": -89.634874,
"Service_Address_Name": "Service Address",
"Service_Street_2": null,
"Service_City": "Peoria",
"Service_Country": "United States"
},
"Asset": null,
"id": "1011000000185114",
"Discount_Type": null,
"Status": "New",
"Grand_Total": 181,
"Modified_Time": "2022-02-16T21:40:09-08:00",
"Territory": {
"name": "Westbrook",
"id": "1011000000139343"
},
"Due_Date": null,
"Adjustment": 0,
"Created_Time": "2022-01-19T21:49:48-08:00",
"Priority": "Medium",
"Request": null,
"Sub_Total": 170,
"$editable": true,
"Completed_Time": null,
"Contact": {
"name": "Maria LaGuerta",
"id": "1011000000156373"
},
"Type": "Service",
"Parent_Work_Order": null,
"Preference": {
"Preferred_Date_1": null,
"Preferred_Date_2": null,
"Preference_Note": null,
"Preferred_Time": "Morning"
},
"Billing_Address": {
"Billing_Longitude": -89.616373,
"Billing_City": "Peoria",
"Billing_Country": "United States",
"name": "AD-9",
"Billing_Address_Name": "Billing Address",
"Billing_Street_1": "1519 W Altorfer Dr",
"Billing_State": "Illinois",
"Billing_Zip_Code": "61615",
"Billing_Street_2": null,
"Billing_Latitude": 40.786193,
"id": "1011000000156382"
},
"Summary": "Leakage Repair",
"Created_By": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
}
},
{
"Owner": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Estimate": null,
"Company": {
"name": "Nebula",
"id": "1011000000139165"
},
"Email": "lucy.robins@zylker.com",
"Discount": null,
"$currency_symbol": "$",
"Cancellation_Reason": null,
"Config": "{\"sales_tax_type\":\"exclusive\",\"tax_rounding_type\":\"not_configured\",\"Type\":\"32\",\"is_discount_before_tax\":true,\"is_inclusive_tax\":false,\"is_discount_tax_inclusive\":false,\"discount_type\":\"item_level\",\"is_sales_inclusive_tax_enabled\":false,\"transaction_rounding_type\":\"nearest_whole_number_rounding\",\"Tax_Details\":{\"Tax_Percentage\":6.25,\"Tax_Id\":\"2908070000000075018\",\"taxFromModule\":\"Addresses\",\"Tax_Name\":\"IllinoisSalesTax\",\"Taxable\":true}}",
"Closed_Time": null,
"Cancelled_Or_Terminated_Time": null,
"Dispatcher": {
"name": "Daniel Warne",
"id": "1011000000139001"
},
"Name": "WO20",
"Tax_Amount": 21.89,
"Invalid_Data": false,
"Modified_By": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
},
"Exchange_Rate": 1,
"Cancellation_Message": null,
"Phone": null,
"Currency": "USD",
"Service_Address": {
"Service_Latitude": 39.287425,
"Service_Street_1": "10 Oak St",
"Service_State": "Illinois",
"Service_Zip_Code": "62553",
"name": "AD-2",
"id": "1011000000139170",
"Service_Longitude": -89.108759,
"Service_Address_Name": "Service Address",
"Service_Street_2": null,
"Service_City": "Oconee",
"Service_Country": "United States"
},
"Asset": null,
"id": "1011000000185005",
"Discount_Type": null,
"Status": "In Progress",
"Grand_Total": 372,
"Modified_Time": "2022-02-09T21:21:41-08:00",
"Territory": {
"name": "Zylker",
"id": "1011000000139148"
},
"Due_Date": "2021-12-27",
"Adjustment": null,
"Created_Time": "2022-01-19T21:48:08-08:00",
"Priority": "Medium",
"Request": null,
"Sub_Total": 350.25,
"$editable": true,
"Completed_Time": null,
"Contact": {
"name": "Joe Molinaro",
"id": "1011000000139167"
},
"Type": "Service",
"Parent_Work_Order": null,
"Preference": {
"Preferred_Date_1": "2021-12-27",
"Preferred_Date_2": null,
"Preference_Note": null,
"Preferred_Time": "Any time"
},
"Billing_Address": {
"Billing_Longitude": -89.107787,
"Billing_City": "Oconee",
"Billing_Country": "United States",
"name": "AD-1",
"Billing_Address_Name": "Billing Address",
"Billing_Street_1": "Locust St",
"Billing_State": "Illinois",
"Billing_Zip_Code": "62553",
"Billing_Street_2": null,
"Billing_Latitude": 39.286597,
"id": "1011000000139169"
},
"Summary": "Home Painting",
"Created_By": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "lucy.robins@zylker.com"
}
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}