customer_memberships_get_list

Retrieve a filtered list of customer memberships in ServiceTitan by specifying criteria like status, billing frequency, creation date, and more, using the ServiceTitan MCP Server.

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]
`billingFrequency`	No	Filters by membership billing frequency Values: [OneTime, Monthly, EveryOtherMonth, Quarterly, BiAnnual, Annual]
`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)
`customerIds`	No	Filters by customer IDs
`duration`	No	Format - int32. Filters by membership duration (in months); use null for ongoing memberships
`ids`	No	Perform lookup by multiple IDs (maximum 50)
`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)
`status`	No	Filters by membership status Values: [Active, Suspended, Expired, Canceled, Deleted]
`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"
      ]
    },
    "billingFrequency": {
      "description": "Filters by membership billing frequency\nValues: [OneTime, Monthly, EveryOtherMonth, Quarterly, BiAnnual, Annual]",
      "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)"
    },
    "customerIds": {
      "description": "Filters by customer IDs",
      "type": [
        "string",
        "null"
      ]
    },
    "duration": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Format - int32. Filters by membership duration (in months); use null for ongoing memberships"
    },
    "ids": {
      "description": "Perform lookup by multiple IDs (maximum 50)",
      "type": [
        "string",
        "null"
      ]
    },
    "includeTotal": {
      "description": "Whether total count should be returned",
      "type": [
        "boolean",
        "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)"
    },
    "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)"
    },
    "status": {
      "description": "Filters by membership status\nValues: [Active, Suspended, Expired, Canceled, Deleted]",
      "type": [
        "string",
        "null"
      ]
    },
    "tenant": {
      "description": "Format - int64. Tenant ID",
      "type": "integer"
    }
  },
  "required": [
    "tenant"
  ],
  "type": "object"
}

ServiceTitan MCP Server

customer_memberships_get_list

Input Schema

Input Schema (JSON Schema)

Other Tools from ServiceTitan MCP Server

Related Tools