reviews
Retrieve and filter customer reviews within ServiceTitan by tenant, date range, rating, status, and associated entities like location, technician, or campaign for detailed analysis.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignIds | No | ||
| createdBefore | No | Format - date-time (as date-time in RFC3339). | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). | |
| fromDate | No | Format - date-time (as date-time in RFC3339). | |
| fromRating | No | Format - float. | |
| includeReviewsWithoutCampaign | No | ||
| includeReviewsWithoutLocation | No | ||
| includeReviewsWithoutTechnician | No | ||
| includeTotal | No | ||
| locationIds | No | ||
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). | |
| page | No | Format - int32. | |
| pageSize | No | Format - int32. | |
| reportType | No | Format - int32. | |
| responseTypes | No | ||
| reviewStatuses | No | ||
| search | No | ||
| sort | No | ||
| sources | No | ||
| technicianIds | No | ||
| tenant | Yes | The tenant identifier. | |
| toDate | No | Format - date-time (as date-time in RFC3339). | |
| toRating | No | Format - float. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaignIds": {
"items": {
"type": "integer"
},
"type": "array"
},
"createdBefore": {
"description": "Format - date-time (as date-time in RFC3339).",
"format": "date-time",
"type": "string"
},
"createdOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339).",
"format": "date-time",
"type": "string"
},
"fromDate": {
"description": "Format - date-time (as date-time in RFC3339).",
"format": "date-time",
"type": "string"
},
"fromRating": {
"description": "Format - float.",
"type": "number"
},
"includeReviewsWithoutCampaign": {
"type": "boolean"
},
"includeReviewsWithoutLocation": {
"type": "boolean"
},
"includeReviewsWithoutTechnician": {
"type": "boolean"
},
"includeTotal": {
"type": "boolean"
},
"locationIds": {
"items": {
"type": "integer"
},
"type": "array"
},
"modifiedBefore": {
"description": "Format - date-time (as date-time in RFC3339).",
"format": "date-time",
"type": "string"
},
"modifiedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339).",
"format": "date-time",
"type": "string"
},
"page": {
"description": "Format - int32.",
"type": "integer"
},
"pageSize": {
"description": "Format - int32.",
"type": "integer"
},
"reportType": {
"description": "Format - int32.",
"type": "integer"
},
"responseTypes": {
"items": {
"type": "string"
},
"type": "array"
},
"reviewStatuses": {
"items": {
"type": "string"
},
"type": "array"
},
"search": {
"type": "string"
},
"sort": {
"type": "string"
},
"sources": {
"items": {
"type": "string"
},
"type": "array"
},
"technicianIds": {
"items": {
"type": "integer"
},
"type": "array"
},
"tenant": {
"description": "The tenant identifier.",
"type": "string"
},
"toDate": {
"description": "Format - date-time (as date-time in RFC3339).",
"format": "date-time",
"type": "string"
},
"toRating": {
"description": "Format - float.",
"type": "number"
}
},
"required": [
"tenant"
],
"type": "object"
}