Requests APIs

Requests are initiated to requisition service tasks. Service tasks are the offerings you provide as part of your field services.

List Requests

Purpose

To fetch the list of all available requests.

Request URL

https://fsm.zoho.com/fsm/v1/Requests

Request Method

GET

Scope

scope=ZohoFSM.modules.Requests.READ

Parameters

Parameter NameData TypeDescriptionPossible Values
page (optional)IntegerTo get the list of records from the respective pages. Default value for page is 1.Positive Integer values only
per_page (optional)IntegerTo get the list of records available per page. Default value for page is 200.Positive Integer values only

Sample Request

Copiedcurl --location --request GET 'https://fsm.zoho.com/fsm/v1/Requests' \
--header 'Authorization: Zoho-oauthtoken 1000.b3xxxxxx.xxxxxxxx3'

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Company": null,
            "Email": null,
            "$currency_symbol": "$",
            "Cancellation_Reason": null,
            "Config": null,
            "Closed_Time": null,
            "Reported_By": null,
            "Cancelled_Or_Terminated_Time": null,
            "Dispatcher": {
                "name": "Warne",
                "id": "1011000000139001"
            },
            "Name": "REQ13",
            "Modified_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Exchange_Rate": 1,
            "Phone": null,
            "Cancellation_Message": null,
            "Currency": "USD",
            "Service_Address": {
                "Service_Latitude": 39.287425,
                "Service_Street_1": "10 Oak St",
                "Service_State": "Illinois",
                "Service_Zip_Code": "62553",
                "name": "AD-5",
                "id": "1011000000141109",
                "Service_Longitude": -89.108759,
                "Service_Address_Name": "Service Address",
                "Service_Street_2": null,
                "Service_City": "Oconee",
                "Service_Country": "United States"
            },
            "Asset": null,
            "id": "1011000000199199",
            "Status": "New",
            "Territory": {
                "name": "Zylker",
                "id": "1011000000139148"
            },
            "Modified_Time": "2022-02-09T01:29:46-08:00",
            "Due_Date": null,
            "Created_Time": "2022-02-09T01:29:46-08:00",
            "Priority": null,
            "$editable": true,
            "Completed_Time": null,
            "Estimate_Required": false,
            "Contact": {
                "name": "Dexter Morgan",
                "id": "1011000000141106"
            },
            "Parent_Work_Order": null,
            "Request_Origin": null,
            "Preference": {
                "Preferred_Date_1": null,
                "Preferred_Date_2": null,
                "Preference_Note": null,
                "Preferred_Time": null
            },
            "Billing_Address": {
                "Billing_Longitude": -89.107787,
                "Billing_City": "Oconee",
                "Billing_Country": "United States",
                "name": "AD-4",
                "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": "1011000000141108"
            },
            "Summary": "Sample",
            "Created_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            }
        },
        {
            "Owner": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Company": {
                "name": "Nebula",
                "id": "1011000000139165"
            },
            "Email": "lucy.robins@zylker.com",
            "$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,\"isBlueprint\":\"simple\",\"discount_type\":\"item_level\",\"is_sales_inclusive_tax_enabled\":false,\"transaction_rounding_type\":\"no_rounding\",\"Tax_Details\":{\"Tax_Percentage\":6.25,\"Tax_Id\":\"2908070000000075018\",\"taxFromModule\":\"Addresses\",\"Tax_Name\":\"IllinoisSalesTax\",\"Taxable\":true}}",
            "Closed_Time": null,
            "Reported_By": null,
            "Cancelled_Or_Terminated_Time": null,
            "Dispatcher": {
                "name": "Pollan",
                "id": "1011000000139328"
            },
            "Name": "REQ1",
            "Modified_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Exchange_Rate": 1,
            "Phone": "111-111-1111",
            "Cancellation_Message": 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": "1011000000141058",
            "Status": "Completed",
            "Territory": {
                "name": "Zylker",
                "id": "1011000000139148"
            },
            "Modified_Time": "2021-12-13T22:43:25-08:00",
            "Due_Date": "2021-11-17",
            "Created_Time": "2021-11-17T01:51:42-08:00",
            "Priority": "Medium",
            "$editable": true,
            "Completed_Time": null,
            "Estimate_Required": false,
            "Contact": {
                "name": "Joe Molinaro",
                "id": "1011000000139167"
            },
            "Parent_Work_Order": null,
            "Request_Origin": null,
            "Preference": {
                "Preferred_Date_1": null,
                "Preferred_Date_2": null,
                "Preference_Note": null,
                "Preferred_Time": "Morning"
            },
            "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": "Bathroom Plumbing",
            "Created_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}