locations_getnotes
Retrieve location notes from ServiceTitan API by specifying ID, date range, and pagination parameters to filter and manage note data effectively.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| createdBefore | No | Format - date-time (as date-time in RFC3339). Returns notes created before the requested date (in UTC) | |
| createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Returns notes created on or after the requested date (in UTC) | |
| id | Yes | Format - int64. | |
| includeTotal | No | Whether total count should be returned | |
| modifiedBefore | No | Format - date-time (as date-time in RFC3339). Returns notes modified before the requested date (in UTC) | |
| modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Returns notes modified after the requested date (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 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"createdBefore": {
"description": "Format - date-time (as date-time in RFC3339). Returns notes created before the requested date (in UTC)",
"format": "date-time",
"type": "string"
},
"createdOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Returns notes created on or after the requested date (in UTC)",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Format - int64.",
"type": "integer"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": "boolean"
},
"modifiedBefore": {
"description": "Format - date-time (as date-time in RFC3339). Returns notes modified before the requested date (in UTC)",
"format": "date-time",
"type": "string"
},
"modifiedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Returns notes modified after the requested date (in UTC)",
"format": "date-time",
"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"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"id",
"tenant"
],
"type": "object"
}