customer_memberships_get_list
Retrieve customer membership details from ServiceTitan by filtering by IDs, status, duration, billing frequency, and activity. Supports pagination and date-based queries for precise results.
Input Schema
TableJSON 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) | |
| 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 |