locations_get_list

Retrieve a filtered list of customer locations by specifying parameters such as city, state, zip, or creation/modification dates. Supports sorting, pagination, and external data lookups.

Input Schema

Name	Required	Description
`active`	No	What kind of items should be returned (only active items will be returned by default) Values: [True, Any, False]
`city`	No	Filters by customer's city
`country`	No	Filters by customer's country
`createdBefore`	No	Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)
`createdOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)
`customerId`	No	Format - int64. Filters by customer ID
`externalDataApplicationGuid`	No	Format - guid. Returns location records with external data for a particular GUID
`externalDataKey`	No	Performs lookup by external data key, 'externalDataValues' must also be provided.
`externalDataValues`	No	Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided.
`ids`	No	Perform lookup by multiple IDs (maximum 50)
`includeTotal`	No	Whether total count should be returned
`latitude`	No	Format - double. Filters by customer's latitude
`longitude`	No	Format - double. Filters by customer's longitude
`modifiedBefore`	No	Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)
`modifiedOnOrAfter`	No	Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)
`name`	No	Filters by customer's name
`page`	No	Format - int32. The logical number of page to return, starting from 1
`pageSize`	No	Format - int32. How many records to return (50 by default)
`sort`	No	Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn.
`state`	No	Filters by customer's state
`street`	No	Filters by customer's street
`tenant`	Yes	Format - int64. Tenant ID
`unit`	No	Filters by customer's unit
`zip`	No	Filters by customer's zip

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "active": {
      "description": "What kind of items should be returned (only active items will be returned by default)\nValues: [True, Any, False]",
      "type": [
        "string",
        "null"
      ]
    },
    "city": {
      "description": "Filters by customer's city",
      "type": [
        "string",
        "null"
      ]
    },
    "country": {
      "description": "Filters by customer's country",
      "type": [
        "string",
        "null"
      ]
    },
    "createdBefore": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)"
    },
    "createdOnOrAfter": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)"
    },
    "customerId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int64. Filters by customer ID"
    },
    "externalDataApplicationGuid": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - guid. Returns location records with external data for a particular GUID"
    },
    "externalDataKey": {
      "description": "Performs lookup by external data key, 'externalDataValues' must also be provided.",
      "type": [
        "string",
        "null"
      ]
    },
    "externalDataValues": {
      "description": "Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided.",
      "type": [
        "string",
        "null"
      ]
    },
    "ids": {
      "description": "Perform lookup by multiple IDs (maximum 50)",
      "type": [
        "string",
        "null"
      ]
    },
    "includeTotal": {
      "description": "Whether total count should be returned",
      "type": [
        "boolean",
        "null"
      ]
    },
    "latitude": {
      "description": "Format - double. Filters by customer's latitude",
      "type": [
        "number",
        "null"
      ]
    },
    "longitude": {
      "description": "Format - double. Filters by customer's longitude",
      "type": [
        "number",
        "null"
      ]
    },
    "modifiedBefore": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)"
    },
    "modifiedOnOrAfter": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)"
    },
    "name": {
      "description": "Filters by customer's name",
      "type": [
        "string",
        "null"
      ]
    },
    "page": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. The logical number of page to return, starting from 1"
    },
    "pageSize": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. How many records to return (50 by default)"
    },
    "sort": {
      "description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.\n\nAvailable fields are: Id, ModifiedOn, CreatedOn.",
      "type": [
        "string",
        "null"
      ]
    },
    "state": {
      "description": "Filters by customer's state",
      "type": [
        "string",
        "null"
      ]
    },
    "street": {
      "description": "Filters by customer's street",
      "type": [
        "string",
        "null"
      ]
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    },
    "unit": {
      "description": "Filters by customer's unit",
      "type": [
        "string",
        "null"
      ]
    },
    "zip": {
      "description": "Filters by customer's zip",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

locations_get_list

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools