appointment_assignments_get_list

Retrieve a list of appointment assignments using filters like ID, job ID, creation/modification dates, and sorting options. Accessible via the ServiceTitan MCP Server for efficient API integration.

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]
`appointmentIds`	No	Return appointment assignments for one or more appointments
`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)
`ids`	No	Perform lookup by multiple IDs (maximum 50)
`includeTotal`	No	Whether total count should be returned
`jobId`	No	Format - int64. Return appointment assignments for a single job
`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, CreatedOn, ModifiedOn.
`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"
    },
    "appointmentIds": {
      "description": "Return appointment assignments for one or more appointments",
      "type": "string"
    },
    "createdBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "createdOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "ids": {
      "description": "Perform lookup by multiple IDs (maximum 50)",
      "type": "string"
    },
    "includeTotal": {
      "description": "Whether total count should be returned",
      "type": "boolean"
    },
    "jobId": {
      "description": "Format - int64. Return appointment assignments for a single job",
      "type": "integer"
    },
    "modifiedBefore": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "modifiedOnOrAfter": {
      "description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)",
      "format": "date-time",
      "type": "string"
    },
    "page": {
      "description": "Format - int32. The logical number of page to return, starting from 1",
      "type": "integer"
    },
    "pageSize": {
      "description": "Format - int32. How many records to return (50 by default)",
      "type": "integer"
    },
    "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, CreatedOn, ModifiedOn.",
      "type": "string"
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

appointment_assignments_get_list

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools