Search Service Territories

Purpose

To search service territories using specific criteria.

Request URL

https://fsm.zoho.com/fsm/v1/Territories/search

Request Method

GET

Scope

scope=ZohoFSM.modules.Territories.READ

Query Parameters

Parameter NameData TypeDescriptionMandatory
api_nameString

API name of the criteria to search by. You can search using the following:
Name, City, State, Country, Zip_Code

Yes
valueStringSearch stringYes
page (optional)IntegerTo get the list of records from the respective pages. Default value for page is 1. 
per_page (optional)IntegerTo get the list of records available per page. Default value for page is 200. 

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Territories/search?api_name=Name&value=Test' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxx.xxxxxe'

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Lucy Robins",
                "id": "2373000000205001",
                "email": "lucy.robins@zylker.com"
            },
            "Description": null,
            "Created_Time": "2023-03-06T04:12:33-08:00",
            "$editable": true,
            "Latitude": null,
            "City": "Glendive",
            "is_Owner_Available": false,
            "Longitude": null,
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Name": "Montana",
            "State": "Montana",
            "$inactive": false,
            "Street": "1919 N Merrill Ave",
            "Country": "United States",
            "Zip_Code": "59330",
            "id": "2373000000205253",
            "Created_By": {
                "name": "Lucy Robins",
                "id": "2373000000205001",
                "email": "lucy.robins@zylker.com"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}