technician_shifts_get_list
Retrieve technician shift details from ServiceTitan by filtering parameters like date range, shift type, technician ID, and custom criteria. Supports pagination and sorting for efficient data access.
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] | |
| 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) | |
| endsOnOrBefore | No | Format - date-time (as date-time in RFC3339). When the End of shift should be at or before | |
| 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) | |
| noteContains | No | Text that must appear in the Note | |
| 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) | |
| shiftType | No | Value to match ShiftType to Values: [Normal, OnCall, TimeOff] | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, CreatedOn, ModifiedOn. | |
| startsOnOrAfter | No | Format - date-time (as date-time in RFC3339). When the Start of shift should be at or after | |
| technicianId | No | Format - int64. Unique Id of technician shift must apply to | |
| tenant | Yes | Format - int64. Tenant ID | |
| titleContains | No | Text that must appear in the Title |
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",
"null"
]
},
"createdBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)"
},
"createdOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)"
},
"endsOnOrBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). When the End of shift should be at or before"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"modifiedBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)"
},
"modifiedOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)"
},
"noteContains": {
"description": "Text that must appear in the Note",
"type": [
"string",
"null"
]
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. The logical number of page to return, starting from 1"
},
"pageSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. How many records to return (50 by default)"
},
"shiftType": {
"description": "Value to match ShiftType to\nValues: [Normal, OnCall, TimeOff]",
"type": [
"string",
"null"
]
},
"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, CreatedOn, ModifiedOn.",
"type": [
"string",
"null"
]
},
"startsOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). When the Start of shift should be at or after"
},
"technicianId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Unique Id of technician shift must apply to"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"titleContains": {
"description": "Text that must appear in the Title",
"type": [
"string",
"null"
]
}
},
"required": [
"tenant"
],
"type": "object"
}