Equipment APIs
Equipments are tools or vehicles that are owned by a field services organization and are utilized to perform various field services.
List Equipments
Purpose
To fetch the list of all available equipments. The records fetched will be sorted by Created Time in descending order (recent ones first).
Request URL
https://fsm.zoho.com/fsm/v1/Equipments
Request Method
GET
Scope
scope=ZohoFSM.modules.Equipment.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 --location --request GET 'https://fsm.zoho.com/fsm/v1/Equipments' \
--header 'Authorization: Zoho-oauthtoken 1000.b3xxxxxx.xxxxxxxx3'Sample Response
Copied{
"data": [
{
"Status": "Active",
"Service_Resources": {
"id": "1003000001809127",
"isActive": true,
"Name": "Medium Wheel Loader"
},
"Owner": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
},
"Modified_Time": "2024-12-10T13:19:06+05:30",
"Description": "168 kW, 18849 kg",
"Equipment_Serial_Number": "WL-0001",
"Created_Time": "2024-08-06T16:08:41+05:30",
"Equipment_Model_Number": "950 GC",
"$editable": true,
"Warranty_Status": "Active",
"$permissions": {
"read": true,
"edit": true,
"delete": true
},
"Name": "Medium Wheel Loader",
"Type": "Vehicle",
"Modified_By": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
},
"Purchased_Date": null,
"$inactive": false,
"Warranty_Expired_Date": "2026-08-06",
"id": "1003000001809122",
"Created_By": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
}
},
{
"Status": "Active",
"Service_Resources": {
"id": "1003000001809109",
"isActive": true,
"Name": "Uniworld Ride On Road Roller"
},
"Owner": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
},
"Modified_Time": "2024-12-10T13:19:14+05:30",
"Description": "9 HP, 750 Kg",
"Equipment_Serial_Number": "UW3-1001",
"Created_Time": "2024-08-06T16:02:59+05:30",
"Equipment_Model_Number": "UW3",
"$editable": true,
"Warranty_Status": "Active",
"$permissions": {
"read": true,
"edit": true,
"delete": true
},
"Name": "Uniworld Ride On Road Roller",
"Type": "Compactor",
"Modified_By": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
},
"Purchased_Date": null,
"$inactive": false,
"Warranty_Expired_Date": "2025-08-06",
"id": "1003000001809104",
"Created_By": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
}
},
{
"Status": "Active",
"Service_Resources": {
"id": "1003000001779513",
"isActive": true,
"Name": "Demolition 16 Kg Road Hammer Drill Machine"
},
"Owner": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
},
"Modified_Time": "2024-12-10T13:19:19+05:30",
"Description": "Electric model, 230V Single Phase",
"Equipment_Serial_Number": "GBM",
"Created_Time": "2024-07-30T17:53:14+05:30",
"Equipment_Model_Number": "0-2600",
"$editable": true,
"Warranty_Status": "Active",
"$permissions": {
"read": true,
"edit": true,
"delete": true
},
"Name": "Demolition 16 Kg Road Hammer Drill Machine",
"Type": "Power Tools",
"Modified_By": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
},
"Purchased_Date": null,
"$inactive": false,
"Warranty_Expired_Date": "2029-07-30",
"id": "1003000001779508",
"Created_By": {
"name": "Marianne Sheehan",
"id": "1003000000208001",
"email": "marianne@noemail.com"
}
}
],
"info": {
"per_page": 200,
"count": 3,
"page": 1,
"more_records": false
}
}Show full
Show less