Views APIs

A View in Zoho FSM refer to a collection of records filtered based on specific criteria. It enables you to easily access important information and efficiently manage your data. There are two types of View - Default, Custom.

List Views

Purpose

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

Request URL

https://fsm.zoho.com/fsm/v1/settings/custom_views

Request Method

GET

Scope

scope=ZohoFSM.settings.custom_views.READ

Parameters

Name	Data Type	Description	Mandatory
module	String	The API name of the module whose views you want to fetch. The possible values are: Requests, Estimates, Work_Orders, Service_Appointments, Contacts, Companies, Assets, Service_And_Parts, Service_Reports, Scheduled_Maintenances, Time_Off, Trips, Crews, Equipments, Skills, Territories, Service_Resources, Calls, Retainer_Invoices	Yes
page (optional)	Integer	The page from which you want to fetch the records. The default value is 1.
per_page (optional)	Integer	The number of records you want to fetch in a page. The default value is 200.

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/settings/custom_views?module=Requests' \
--header 'Authorization: Zoho-oauthtoken 1000.3xxxxxxxxx.xxxxxxxxxxxxx0e'

Sample Response

Copied{
    "custom_views": [
        {
            "display_value": "Requests Converted to Estimates",
            "offline": true,
            "default": false,
            "api_name": "Requests_Converted_to_Estimates",
            "system_name": null,
            "system_defined": true,
            "name": "Requests Converted to Estimates",
            "id": "1003000000164755",
            "category": "public_views",
            "favorite": null
        },
        {
            "display_value": "Requests with Rejected Estimates",
            "offline": true,
            "default": false,
            "api_name": "Requests_with_Rejected_Estimates",
            "system_name": null,
            "system_defined": true,
            "name": "Requests with Rejected Estimates",
            "id": "1003000000164743",
            "category": "public_views",
            "favorite": null
        }
    ],
    "info": {
        "per_page": 200,
        "default": "1003000000164717",
        "count": 2,
        "translation": {
            "public_views": "Public Views",
            "other_users_views": "Other User's Views",
            "shared_with_me": "Shared With Me",
            "created_by_me": "Created By Me"
        },
        "page": 1,
        "more_records": false
    }
}