Service Appointment APIs

Service Appointment is a job created for carrying out the services in a work order.

List Service Appointments


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

Request URL

Request Method




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 --location --request GET '' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxxxxxx.xxxxxxxd'

Sample Response

    "data": [
            "Scheduled_End_Date_Time": "2023-09-29T17:30:00+05:30",
            "Owner": {
                "name": "Diane Lockhart",
                "id": "4776000000223001",
                "email": ""
            "Company": null,
            "Discount": null,
            "$currency_symbol": "$",
            "Actual_Start_Date_Time": null,
            "Cancellation_Reason": null,
            "Cancelled_Or_Terminated_Time": null,
            "User_Lead": {
                "name": "Lockhart",
                "id": "4776000000223001"
            "Name": "AP-2",
            "Tax_Amount": 2.18,
            "Actual_End_Date_Time": null,
            "Modified_By": {
                "name": "Diane Lockhart",
                "id": "4776000000223001",
                "email": ""
            "Exchange_Rate": 1,
            "Cancellation_Message": null,
            "Currency": "USD",
            "$inactive": false,
            "Service_Address": {
                "Service_Latitude": 13.08268,
                "Service_Street_1": null,
                "Service_State": "Tamil Nadu",
                "Service_Zip_Code": null,
                "name": "AD-11",
                "id": "4776000000230245",
                "Service_Longitude": 80.270718,
                "Service_Address_Name": "Service Address",
                "Service_Street_2": null,
                "Service_Google_Geocodedtime": null,
                "Service_City": null,
                "Service_Country": null
            "Lead": {
                "name": "Diane Lockhart",
                "id": "4776000000223235",
                "user": "4776000000223001"
            "Asset": null,
            "id": "4776000000249126",
            "Discount_Type": null,
            "Status": "Dispatched",
            "Territory": {
                "name": "Zylker",
                "id": "4776000000223230"
            "Modified_Time": "2023-09-29T16:29:12+05:30",
            "Due_Date": null,
            "Adjustment": null,
            "Created_Time": "2023-09-29T16:29:11+05:30",
            "Sub_Total": 30,
            "$editable": true,
            "Invoice_Id": null,
            "Billing_Status": "Not yet Invoiced",
            "Scheduled_Start_Date_Time": "2023-09-29T16:30:00+05:30",
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            "Contact": {
                "name": "Alicia Florrick",
                "id": "4776000000230219"
            "Preference": {
                "Preferred_Date_1": null,
                "Preferred_Date_2": null,
                "Preference_Note": null,
                "Preferred_Time": null
            "Total": 32.18,
            "Summary": "Leaking faucet",
            "Created_By": {
                "name": "Diane Lockhart",
                "id": "4776000000223001",
                "email": ""
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false