membership_types_get_list
Retrieve a filtered list of membership types from the ServiceTitan API based on criteria such as billing frequency, duration, creation/modification dates, and active status.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
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) | |
duration | No | Format - int32. Filters by membership duration (in months); use null for ongoing memberships | |
ids | No | Perform lookup by multiple IDs (maximum 50) | |
includeDurationBilling | No | Whether duration/billing should be included in the result | |
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) | |
tenant | Yes | Format - int64. Tenant ID |