Time Sheet APIs

Time spent working on an appointment can be logged using Time Sheets.

List Time Sheets

Purpose

To fetch all the time sheets of a service appointment. The records fetched will be sorted by Created Time in descending order (recent ones first).

Request URL

https://fsm.zoho.com/fsm/v1/Service_Appointments/<appointment_id>/Time_Sheets

<appointment_id> - The ID of the service appointment.

Request Method

GET

Scope

scope=ZohoFSM.modules.TimeSheets.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 --request GET 'https://fsm.zoho.com/fsm/v1/Service_Appointments/1003000001893608/Time_Sheets' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxxxx.xxxxxxe'

Sample Response

Copied{
 "data": [
 {
 "Owner": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Modified_Time": "2025-01-22T11:29:57+05:30",
 "Description": null,
 "$currency_symbol": "$",
 "Created_Time": "2025-01-22T11:29:57+05:30",
 "duration_formatted": "2 Hr(s) ",
 "$editable": true,
 "Duration": "120",
 "$permissions": {
 "read": true,
 "edit": true,
 "delete": true
 },
 "Name": "TS71",
 "Service_Resource": {
 "name": "Marianne Sheehan",
 "id": "1003000000208159"
 },
 "End_Date_Time": "2024-12-23T14:00:00+05:30",
 "Modified_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Start_Date_Time": "2024-12-23T12:00:00+05:30",
 "Exchange_Rate": 1,
 "Currency": "USD",
 "$inactive": false,
 "Service_Appointment": {
 "name": "AP-59",
 "id": "1003000001893608"
 },
 "Timesheet_X_Services": [
 {
 "Service_Task_Line_Item": null,
 "Owner": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Modified_Time": "2025-01-22T11:29:58+05:30",
 "Created_Time": "2025-01-22T11:29:58+05:30",
 "Timesheet": {
 "name": "TS71",
 "id": "1003000002329039"
 },
 "$editable": true,
 "$permissions": {
 "read": true,
 "edit": true,
 "delete": true
 },
 "Name": "TSxSRVC-85",
 "Modified_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Exchange_Rate": 1,
 "Currency": "USD",
 "$inactive": false,
 "Service_Line_Item": {
 "name": "SVC-98",
 "Service": "1003000001809181",
 "id": "1003000001893206"
 },
 "id": "1003000002329046",
 "Created_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 }
 }
 ],
 "id": "1003000002329039",
 "Created_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 }
 },
 {
 "Owner": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Modified_Time": "2024-09-23T17:44:26+05:30",
 "Description": null,
 "$currency_symbol": "$",
 "Created_Time": "2024-09-23T17:14:27+05:30",
 "duration_formatted": "29 Min(s) 26 secs",
 "$editable": true,
 "Duration": "29",
 "$permissions": {
 "read": true,
 "edit": true,
 "delete": true
 },
 "Name": "TS52",
 "Service_Resource": {
 "name": "Demolition 16 Kg Road Hammer Drill Machine",
 "id": "1003000001779513"
 },
 "End_Date_Time": "2024-09-23T17:44:26+05:30",
 "Modified_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Start_Date_Time": "2024-09-23T17:15:00+05:30",
 "Exchange_Rate": 1,
 "Currency": "USD",
 "$inactive": false,
 "Service_Appointment": {
 "name": "AP-59",
 "id": "1003000001893608"
 },
 "Timesheet_X_Services": [
 {
 "Service_Task_Line_Item": null,
 "Owner": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Modified_Time": "2024-09-23T17:14:28+05:30",
 "Created_Time": "2024-09-23T17:14:28+05:30",
 "Timesheet": {
 "name": "TS52",
 "id": "1003000001978056"
 },
 "$editable": true,
 "$permissions": {
 "read": true,
 "edit": true,
 "delete": true
 },
 "Name": "TSxSRVC-65",
 "Modified_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 },
 "Exchange_Rate": 1,
 "Currency": "USD",
 "$inactive": false,
 "Service_Line_Item": {
 "name": "SVC-98",
 "Service": "1003000001809181",
 "id": "1003000001893206"
 },
 "id": "1003000001978063",
 "Created_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 }
 }
 ],
 "id": "1003000001978056",
 "Created_By": {
 "name": "Marianne Sheehan",
 "id": "1003000000208001",
 "email": "marianne@noemail.com"
 }
 }
 ],
 "info": {
 "per_page": 200,
 "count": 2,
 "page": 1,
 "more_records": false
 }
}