Get Service Territories

Display the available service territories on the first screen of your appointment scheduling app.

A service territory represents a branch or office location where your service resources (appointment attendees) operate from or meet customers.

Create a page where you can provide users an option to search for service territories. Here’s how a Select Service Territory page can look.A representation of the Select Service Territory screen.

You can search for service territories based on the user-entered name, city, postal code, or state. You can also calculate the distance between two location values, such as between a service territory and the user's current location.

You can Retrieve records with locations within or outside of a certain radius with distance conditions in the WHERE clause of the query. For more information, see the WHERE clause section in Location-Based SOQL Queries.

  1. Use the Query() request on the ServiceTerritory object to retrieve a list of active service territories from your Salesforce org.
    Sample Request

    This sample REST API call uses the Query() request to retrieve service territories within a range of 1 mile from your current location. Default value is 5 miles.

    For more information on using Query() request, see Execute a SOQL Query.

    https://yourInstance.salesforce.com/services/data/vXX.X/query/?q=
    SELECT City,Country,Id,Name,State FROM ServiceTerritory WHERE DISTANCE(Address, GEOLOCATION(17.4358411,78.3467857), 'mi') < 1
    Sample Response

    The request returns the service territory records.

    {
      "totalSize": 4,
      "done": true,
      "records": [
        {
          "attributes": {
            "type": "ServiceTerritory",
            "url": "/services/data/v55.0/sobjects/ServiceTerritory/0Hhx000000012oOCAQ"
          },
          "City": "Hyderabad",
          "Country": "India",
          "Id": "0Hhx000000012oOCAQ",
          "Name": "Apollo Hyderabad",
          "State": "TG"
        },
        {
          "attributes": {
            "type": "ServiceTerritory",
            "url": "/services/data/v55.0/sobjects/ServiceTerritory/0Hhx000000012oRCAQ"
          },
          "City": "Nanakaramguda",
          "Country": "India",
          "Id": "0Hhx000000012oRCAQ",
          "Name": "Somewhere",
          "State": "TG"
        },
        {
          "attributes": {
            "type": "ServiceTerritory",
            "url": "/services/data/v55.0/sobjects/ServiceTerritory/0Hhx000000012oQCAQ"
          },
          "City": "Hyderabad",
          "Country": "India",
          "Id": "0Hhx000000012oQCAQ",
          "Name": "Partner Service Territory",
          "State": "TG"
        },
        {
          "attributes": {
            "type": "ServiceTerritory",
            "url": "/services/data/v55.0/sobjects/ServiceTerritory/0Hhx000000012oSCAQ"
          },
          "City": "Hyderabad",
          "Country": "India",
          "Id": "0Hhx000000012oSCAQ",
          "Name": "JPMC Bank, Hyderabad",
          "State": "TG"
        }
      ]
    }

Parse the JSON response, and show the available service territories on the Select Service Territory page so that the user can select a service territory.

Here’s how the service territories are listed based on the users' search.A representation of the Select Service Territory screen.

On the next page in your app, you can show the work type groups.