Service Report APIs

A service report is a document that provides a detailed record of a service visit, including the work performed, the services provided, and the customer feedback.

List Service Reports

Purpose

To fetch the list of all available service reports. The records fetched will be sorted by Created Time in descending order (recent ones first).

Request URL

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

Request Method

GET

Scope

scope=ZohoFSM.modules.ServiceReports.READ

Query Parameters

Parameter NameData TypeDescriptionPossible Values
page (optional)IntegerThe page from which you want to fetch the records. The default value is 1.Positive Integer values only
per_page (optional)IntegerThe number of records you want to fetch in a page. The default value is 200.Positive Integer values only

Sample Request

Copiedcurl --location --request GET 'https://fsm.zoho.com/fsm/v1/Service_Reports' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxxxxx.xxxxxxxd'

Sample Response

Copied{
    "data": [
        {
            "Appointment": {
                "name": "AP-101",
                "id": "1003000002638061"
            },
            "Customer_Signature": {
                "Customer_Signature_Uploaded_Time": "2025-05-16T12:30:28+05:30",
                "Customer_Signature_Name": "Endeavour Pvt Ltd",
                "Customer_Signature_Attachment": [
                    {
                        "mode": "",
                        "original_Size_Byte": "1451",
                        "extn": "file",
                        "file_Name": "siganatureFile",
                        "file_Id": "20250516T1230200530705ZriNnX",
                        "download_Url": "fsm.zoho.com/fsm/v1/stratus/downloadObject?file_id=20250516T1230200530705ZriNnX",
                        "attachment_Id": "1003000002638136",
                        "file_Size": "1.45 KB",
                        "creator_Id": 1003000000208001,
                        "link_Docs": 0,
                        "entity_Id": 1003000002638117
                    }
                ]
            },
            "Owner": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "Company": {
                "name": "Endeavour Pvt Ltd",
                "id": "1003000000208216"
            },
            "$currency_symbol": "$",
            "Config": "{\"$notes\":{\"compression_quality\":\"MEDIUM\",\"image_width\":\"small\",\"Attachments\":[{\"$attachments\":[{\"File_Name\":\"building-block-growth.png\",\"Size\":685826,\"className\":\"img-icon\",\"id\":\"1003000002638104\",\"File_Id\":\"20250516T1228290530650Pgucvg\",\"thumbnailUrl\":\"\"}],\"notes_id\":\"1003000002638094\",\"Size\":685826}]},\"pricing\":true}",
            "Name": "REP-23",
            "Modified_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "$inactive": false,
            "Asset": {
                "name": "SONY Bravia 80.1 cm (32 inch) | KLV-32W562D",
                "id": "1003000000793081"
            },
            "id": "1003000002638117",
            "Customer_Rating": "4",
            "Service_Report_Html": [
                {
                    "mode": "",
                    "original_Size_Byte": "1221627",
                    "extn": "file",
                    "file_Name": "servicereport/1003000002638061/html/1003000002638117",
                    "file_Id": "servicereport/1003000002638061/html/1003000002638117",
                    "download_Url": "fsm.zoho.com/fsm/v1/stratus/downloadObject?file_id=servicereport%2F1003000002638061%2Fhtml%2F1003000002638117",
                    "attachment_Id": "1003000002638127",
                    "file_Size": "1.22 MB",
                    "creator_Id": 1003000000208001,
                    "link_Docs": 0,
                    "entity_Id": 1003000002638117
                }
            ],
            "Status": "Draft",
            "Customer_Feedback": "Good work !!!",
            "Modified_Time": "2025-05-16T12:30:29+05:30",
            "Template_Id": null,
            "Service_Report_PDF": [
                {
                    "mode": "",
                    "original_Size_Byte": "954877",
                    "extn": "file",
                    "file_Name": "01JVBY9X05SDFAW88CY3N584JV",
                    "file_Id": "servicereport/1003000002638061/pdf/1003000002638117",
                    "download_Url": "fsm.zoho.com/fsm/v1/stratus/downloadObject?file_id=servicereport%2F1003000002638061%2Fpdf%2F1003000002638117",
                    "attachment_Id": "1003000002638129",
                    "file_Size": "954.88 KB",
                    "creator_Id": 1003000000208001,
                    "link_Docs": 0,
                    "entity_Id": 1003000002638117
                }
            ],
            "Created_Time": "2025-05-16T12:30:23+05:30",
            "Request": null,
            "$editable": true,
            "Work_Order": {
                "name": "WO03",
                "id": "1003000002638031"
            },
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Technician_Signature": {
                "Technician_Signature_Uploaded_Time": "2025-05-16T12:30:29+05:30",
                "Technician_Signature_Name": "Marianne Sheehan",
                "Technician_Signature_Attachment": [
                    {
                        "mode": "",
                        "original_Size_Byte": "1629",
                        "extn": "file",
                        "file_Name": "siganatureFile",
                        "file_Id": "20250516T12295005302280fulRf",
                        "download_Url": "fsm.zoho.com/fsm/v1/stratus/downloadObject?file_id=20250516T12295005302280fulRf",
                        "attachment_Id": "1003000002638138",
                        "file_Size": "1.63 KB",
                        "creator_Id": 1003000000208001,
                        "link_Docs": 0,
                        "entity_Id": 1003000002638117
                    }
                ]
            },
            "Contact": {
                "name": "Lucy Robins",
                "id": "1003000000365025"
            },
            "Problem_Statement": "TV installed in the guest room",
            "Summary": "TV wall mounting",
            "Pdf_generation": "Completed",
            "Created_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            }
        }

 ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}