Get Related Records
Purpose
To fetch the related records of a module.
Request URL
https://fsm.zoho.com/fsm/v1/<module_api_name>/<record_id>/<related_list_api_name>
module_api_name - The API name of the module whose related record you want to fetch
record_id - The unique ID of the record.
related_list_api_name - The name of the related record you want to fetch.
Request Method
GET
Scope
scope=ZohoFSM.modules.<module_name>.READ
Parameters
| Parameter Name | Data Type | Description | Possible Values |
|---|---|---|---|
| page (optional) | Integer | To get the list of records from the respective pages. Default value for page is 1. | Positive Integer values only |
| per_page (optional) | Integer | To get the list of records available per page. Default value for page is 200. | Positive Integer values only |
Supported Modules and Related Records
| Module Name | API Name | Related Record API Name |
|---|---|---|
| Requests | Requests | Notes, Estimates, Work_Orders |
| WorkOrders | Work_Orders | Notes, Estimates, Work_Orders |
| Estimates | Estimates | Notes |
| ServiceAppointments | Service_Appointments | Notes, Trips, Service_Reports, Time_Sheets |
| Contacts | Contacts | Notes, Assets, Requests, Estimates, Work_Orders, Service_Appointments, Addresses |
| Companies | Companies | Notes, Assets, Requests, Estimates, Work_Orders, Service_Appointments, Addresses, Contacts, Child_Companies |
| Assets | Assets | Notes, Requests, Estimates, Work_Orders, Appointments_for_asset, Child_Assets |
| Service_And_Parts | Service_And_Parts | Service_Tasks |
| Equipment | Equipments | Notes |
Sample Request
Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Contacts/1041000000144173/Service_Appointments?page=1&per_page=5' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxx.xxxxxe'Sample Response
Copied{
"data": [
{
"Scheduled_End_Date_Time": "2021-12-28T03:30:00-08:00",
"Owner": {
"name": "Tracy Pollan",
"id": "1011000000139328",
"email": "xxx@zohotest.com"
},
"Company": {
"name": "Nebula",
"id": "1011000000139165"
},
"$currency_symbol": "$",
"Cancellation_Reason": null,
"Actual_Start_Date_Time": "2022-01-12T01:19:29-08:00",
"Closed_Time": null,
"Cancelled_Or_Terminated_Time": null,
"User_Lead": {
"name": "Pollan",
"id": "1011000000139328"
},
"Name": "AP-18",
"Actual_End_Date_Time": "2022-01-12T01:23:15-08:00",
"Invalid_Data": false,
"Modified_By": {
"name": "Tracy Pollan",
"id": "1011000000139328",
"email": "xxx@zohotest.com"
},
"Exchange_Rate": 1,
"Cancellation_Message": null,
"Currency": "USD",
"Lead": {
"name": "Tracy Pollan",
"id": "1011000000139336"
},
"Service_Address": {
"Service_Latitude": 39.287425,
"name": "AD-11",
"id": "1011000000162021",
"Service_Longitude": -89.108759
},
"Asset": null,
"id": "1011000000165405",
"Status": "Cannot Complete",
"Modified_Time": "2022-01-12T01:23:17-08:00",
"Territory": {
"name": "Fillmore",
"id": "1011000000139175"
},
"Due_Date": "2021-12-28",
"Created_Time": "2021-12-28T02:09:30-08:00",
"$editable": true,
"Invoice_Id": null,
"Scheduled_Start_Date_Time": "2021-12-28T02:30:00-08:00",
"Contact": {
"name": "Angel Batista",
"id": "1011000000162014"
},
"Preference": {
"Preferred_Date_1": "2021-12-28",
"Preferred_Date_2": null,
"Preference_Note": null,
"Preferred_Time": "-None-"
},
"Total": 127,
"Summary": "Carpet Stain Removal",
"Created_By": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "xxx@zohotest.com"
}
},
{
"Scheduled_End_Date_Time": "2021-12-27T02:30:00-08:00",
"Owner": {
"name": "Tracy Pollan",
"id": "1011000000139328",
"email": "xxx@zohotest.com"
},
"Company": {
"name": "Nebula",
"id": "1011000000139165"
},
"$currency_symbol": "$",
"Cancellation_Reason": null,
"Actual_Start_Date_Time": null,
"Closed_Time": null,
"Cancelled_Or_Terminated_Time": null,
"User_Lead": {
"name": "Pollan",
"id": "1011000000139328"
},
"Name": "AP-15",
"Actual_End_Date_Time": null,
"Invalid_Data": false,
"Modified_By": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "xxx@zohotest.com"
},
"Exchange_Rate": 1,
"Cancellation_Message": null,
"Currency": "USD",
"Lead": {
"name": "Tracy Pollan",
"id": "1011000000139336"
},
"Service_Address": {
"Service_Latitude": 39.287425,
"name": "AD-11",
"id": "1011000000162021",
"Service_Longitude": -89.108759
},
"Asset": null,
"id": "1011000000165138",
"Status": "Scheduled",
"Modified_Time": "2021-12-28T23:38:45-08:00",
"Territory": {
"name": "Fillmore",
"id": "1011000000139175"
},
"Due_Date": "2021-12-27",
"Created_Time": "2021-12-27T01:20:21-08:00",
"$editable": true,
"Invoice_Id": null,
"Scheduled_Start_Date_Time": "2021-12-27T01:30:00-08:00",
"Contact": {
"name": "Angel Batista",
"id": "1011000000162014"
},
"Preference": {
"Preferred_Date_1": "2021-12-27",
"Preferred_Date_2": null,
"Preference_Note": null,
"Preferred_Time": "Any time"
},
"Total": 181,
"Summary": "Sundry repairs",
"Created_By": {
"name": "Daniel Warne",
"id": "1011000000139001",
"email": "xxx@zohotest.com"
}
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}