Vendors_GetList

Vendors_GetList

Retrieve and filter vendor lists from ServiceTitan by ID, activity status, creation/modification dates, external data, or sorting criteria to manage vendor data efficiently.

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]
`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)
`externalDataApplicationGuid`	No	Format - guid. If this guid is provided, external data corresponding to this application guid will be returned.
`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	Ids to filter by
`includeTotal`	No	Whether total count should be returned
`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)
`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.
`tenant`	Yes	Format - int64. Tenant ID

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "active": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "string"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "What kind of items should be returned (only active items will be returned by default)\nValues: [True, Any, False]"
    },
    "createdBefore": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "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": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "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)"
    },
    "externalDataApplicationGuid": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "format": "uuid",
              "type": "string"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - guid. If this guid is provided, external data corresponding to\nthis application guid will be returned."
    },
    "externalDataKey": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "string"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Performs lookup by external data key, 'externalDataValues' must also be provided."
    },
    "externalDataValues": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "string"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided."
    },
    "ids": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "items": {
                "type": "integer"
              },
              "type": "array"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Ids to filter by"
    },
    "includeTotal": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "boolean"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Whether total count should be returned"
    },
    "modifiedBefore": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "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": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "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)"
    },
    "page": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "integer"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. The logical number of page to return, starting from 1"
    },
    "pageSize": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "integer"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. How many records to return (50 by default)"
    },
    "sort": {
      "anyOf": [
        {
          "anyOf": [
            {
              "not": {}
            },
            {
              "type": "string"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "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."
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools