Time Off APIs

A time off record captures an user's absence from work.

List Time Offs

Purpose

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

Request URL

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

Request Method

GET

Scope

scope=ZohoFSM.modules.TimeOff.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/Time_Off' \
--header 'Authorization: Zoho-oauthtoken 1000.3xxxxxxxxx.xxxxxxxxxxxxx0e'

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Lori Ross",
                "id": "1003000000208179",
                "email": "lori.ross@noemail.com"
            },
            "Modified_Time": "2024-04-02T12:45:05+05:30",
            "Description": "Personal work",
            "Created_Time": "2024-04-02T12:45:05+05:30",
            "$editable": true,
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Reason": "Other work",
            "Name": "AB-3",
            "Service_Resource": {
                "name": "Lori Ross",
                "id": "1003000000293001"
            },
            "End_Date_Time": "2024-04-02T14:00:00+05:30",
            "Modified_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "Start_Date_Time": "2024-04-02T13:00:00+05:30",
            "$inactive": false,
            "id": "1003000001496085",
            "Created_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            }
        },
        {
            "Owner": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "Modified_Time": "2024-04-02T12:39:06+05:30",
            "Description": "Personal work",
            "Created_Time": "2024-04-02T12:39:06+05:30",
            "$editable": true,
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Reason": "Other work",
            "Name": "AB-2",
            "Service_Resource": {
                "name": "Marianne Sheehan",
                "id": "1003000000208159"
            },
            "End_Date_Time": "2024-04-02T14:00:00+05:30",
            "Modified_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            },
            "Start_Date_Time": "2024-04-02T13:00:00+05:30",
            "$inactive": false,
            "id": "1003000001496065",
            "Created_By": {
                "name": "Marianne Sheehan",
                "id": "1003000000208001",
                "email": "marianne@noemail.com"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}