campaigns_get_list
Retrieve a filtered list of campaigns from the ServiceTitan API by specifying tenant ID, date ranges, activity status, or other criteria. Supports pagination, sorting, and optional total count inclusion.
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] | |
| campaignPhoneNumber | No | Filters campaigns by phone number (as string). | |
| 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 | |
| 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) | |
| 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) | |
| sort | No | Applies sorting by the specified field: '?sort=+FieldName' for ascending order, '?sort=-FieldName' for descending order. Available fields are: Id, Name, 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"
},
"campaignPhoneNumber": {
"description": "Filters campaigns by phone number (as string).",
"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"
},
"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"
},
"name": {
"description": "Filters records by name (case-insensitive 'contains' operation)",
"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, Name, CreatedOn, ModifiedOn",
"type": "string"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}