- Overview
- OAuth Authentication
- API Collection
- Requests
- Estimates
- Work Orders
- Service Appointments
- Service Reports
- Invoices
- Contacts
- Companies
- Services/Parts
- Assets
- Time Sheets
- Scheduled Maintenances
- Service Territories
- Skills
- Notes
- Record Templates
- Job Sheets
- Records
- Users
- Equipments
- Time Off
- Files
- Attachments
- Notifications
- Attendance
Job Sheet APIs
Job Sheets are customizable, reusable forms that serve as a checklist for the services that technicians need to carry out and as a tool for data collection.
List Job Sheet Forms
Purpose
To fetch the details of all the job sheet forms created.
Request URL
https://fsm.zoho.com/fsm/v1/meta/job_sheet_forms
Request Method
GET
Scope
scope=ZohoFSM.meta.JobSheets.READ
Parameters
| Name | Data Type | Description |
| status | String | Filter the job sheet forms based on their status. The acceptable values are: ACTIVE, INACTIVE |
| name | String | Filter the job sheet forms using their names. The records whose name or a substring of the name matches the search string will be fetched. |
| services | String | If you want to search the job sheet forms by the services used in it. Provide comma-separated IDs of the services. |
Sample Request
Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/meta/job_sheet_forms?status=ACTIVE&name=Substation&services=1003000002340563,1003000001854696' \
--header 'Authorization: Zoho-oauthtoken 1000.3xxxxxxxxx.xxxxxxxxxxxxx0e'Sample Success Response
Copied{
"job_sheet_forms": [
{
"layout": "1003000001848528",
"modified_on": "2024-08-28T17:03:49+05:30",
"created_on": "2024-08-19T19:03:23+05:30",
"name": "Substation maintenance",
"modified_by": {
"name": "Marianne Sheehan",
"id": "1003000000208001"
},
"description": "",
"id": "1003000001848527",
"services": [
{
"id": "1003000001854006",
"Name": "Substation Equipment - Emergency Repair"
},
{
"id": "1003000001854696",
"Name": "Substation Equipment - Inspection"
},
{
"id": "1003000001854700",
"Name": "Substation Equipment - Testing"
},
{
"id": "1003000001884077",
"Name": "Power Transformer Electrical Testing"
},
{
"id": "1003000001854010",
"Name": "Substation Equipment - Routine Maintenance"
}
],
"created_by": {
"name": "Marianne Sheehan",
"id": "1003000000208001"
},
"status": "ACTIVE"
},
{
"layout": "1003000001854016",
"modified_on": "2024-08-28T17:04:24+05:30",
"created_on": "2024-08-20T16:08:26+05:30",
"name": "Substation Service",
"modified_by": {
"name": "Marianne Sheehan",
"id": "1003000000208001"
},
"description": "",
"id": "1003000001854015",
"services": [
{
"id": "1003000001854006",
"Name": "Substation Equipment - Emergency Repair"
},
{
"id": "1003000001854696",
"Name": "Substation Equipment - Inspection"
},
{
"id": "1003000001854700",
"Name": "Substation Equipment - Testing"
},
{
"id": "1003000001884077",
"Name": "Power Transformer Electrical Testing"
},
{
"id": "1003000001854010",
"Name": "Substation Equipment - Routine Maintenance"
}
],
"created_by": {
"name": "Marianne Sheehan",
"id": "1003000000208001"
},
"status": "ACTIVE"
}
]
}Show full
Show less
Sample Failure Response
Copied{
"code": "INVALID_DATA",
"details": {},
"message": "invalid status",
"status": "error"
}© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.