Service Territories APIs

Service territories are domains that can be geographical, departmental, commercial, or based on any other way you want to segment your business. This demarcation helps you manage contact service requests and service personnel. For example, service territories can be different regions where an organization provides their field services. Service personnel such as dispatchers and field technicians are assigned to these service territories who then handle the service requests in their region. 

List Service Territories

Purpose

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

Request URL

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

Request Method

GET

Scope

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

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Lucy Robins",
                "id": "2373000000205001",
                "email": "lucy.robins@zylker.com"
            },
            "Description": null,
            "Created_Time": "2023-03-06T04:29:52-08:00",
            "$editable": true,
            "Latitude": null,
            "City": "Endako",
            "is_Owner_Available": false,
            "Longitude": null,
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Name": "British Columbia",
            "State": "British Columbia",
            "$inactive": false,
            "Street": "Endako Mines Rd",
            "Country": "Canada",
            "Zip_Code": "V0J 1L0",
            "id": "2373000000205267",
            "Created_By": {
                "name": "Lucy Robins",
                "id": "2373000000205001",
                "email": "lucy.robins@zylker.com"
            }
        },
        {
            "Owner": {
                "name": "Lucy Robins",
                "id": "2373000000205001",
                "email": "lucy.robins@zylker.com"
            },
            "Description": null,
            "Created_Time": "2023-03-06T04:17:06-08:00",
            "$editable": true,
            "Latitude": null,
            "City": "Wendake",
            "is_Owner_Available": false,
            "Longitude": null,
            "$permissions": {
                "read": true,
                "edit": true,
                "delete": true
            },
            "Name": "Quebec",
            "State": "Quebec",
            "$inactive": false,
            "Street": "110 Rue Grand Chef Thonnakona",
            "Country": "Canada",
            "Zip_Code": "G3E 1H1",
            "id": "2373000000205259",
            "Created_By": {
                "name": "Lucy Robins",
                "id": "2373000000205001",
                "email": "lucy.robins@zylker.com"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}