user_roles_get_list

Retrieve a filtered list of user roles from ServiceTitan by applying criteria such as active status, creation date, employee type, or name. Supports pagination and total count inclusion for efficient role management.

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)
`employeeType`	No	Filter roles by employee type Values: [None, Employee, Technician, All]
`ids`	No	Perform lookup by multiple IDs (maximum 50)
`includeTotal`	No	Whether total count should be returned
`name`	No	Filters records by name (case-insensitive 'contains' operation)
`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)
`tenant`	Yes	Format - int64. Tenant ID

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"
      ]
    },
    "createdBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "createdOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
      "type": [
        "string",
        "null"
      ]
    },
    "employeeType": {
      "description": "Filter roles by employee type\nValues: [None, Employee, Technician, All]",
      "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"
      ]
    },
    "name": {
      "description": "Filters records by name (case-insensitive 'contains' operation)",
      "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)"
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

user_roles_get_list

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools