tasks_get_tasks
Retrieve and filter tasks from ServiceTitan using tenant ID, pagination, statuses, dates, and other criteria to manage task lists efficiently.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
active | No | Values: [True, Any, False] | |
assignedToId | No | Format - int64. Assigned to Id | |
businessUnitIds | No | Business Unit Ids (comma separated Ids) | |
completeBefore | No | Format - date-time (as date-time in RFC3339). Completed Before | |
completeOnOrAfter | No | Format - date-time (as date-time in RFC3339). Completed On or After | |
createdBefore | No | Format - date-time (as date-time in RFC3339). Created date before | |
createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Created date on or after | |
customerId | No | Format - int64. Customer Id | |
employeeTaskResolutionIds | No | EmployeeTaskResolution Ids (comma separated Ids) | |
employeeTaskSourceIds | No | EmployeeTaskSource Ids (comma separated Ids) | |
employeeTaskTypeIds | No | EmployeeTaskType Ids (comma separated Ids) | |
ids | No | Task Ids (comma separated Ids) | |
includeSubtasks | No | Include Subtasks | |
includeTotal | No | Whether total count should be returned | |
involvedEmployeeIdList | No | Involved Employee Ids (comma separated Ids) | |
isClosed | No | Is Closed This property is deprecated. Use Statuses instead. | |
jobId | No | Format - int64. Job Id | |
jobNumber | No | Job Number | |
modifiedBefore | No | Format - date-time (as date-time in RFC3339). Modified date before | |
modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Modified date on or after | |
name | No | Name | |
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) | |
priorities | No | Priorities (comma separated values) | |
projectId | No | Format - int64. Project Id | |
reportedBefore | No | Format - date-time (as date-time in RFC3339). Reported date before | |
reportedById | No | Format - int64. Reported By Id | |
reportedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Reported On or After | |
sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, CreatedOn, DescriptionModifiedOn, CompletedBy, Priority | |
statuses | No | Task Status | |
taskNumber | No | Format - int64. Task Number | |
tenant | Yes | Format - int64. Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"active": {
"description": "Values: [True, Any, False]",
"type": "string"
},
"assignedToId": {
"description": "Format - int64. Assigned to Id",
"type": "integer"
},
"businessUnitIds": {
"description": "Business Unit Ids (comma separated Ids)",
"type": "string"
},
"completeBefore": {
"description": "Format - date-time (as date-time in RFC3339). Completed Before",
"format": "date-time",
"type": "string"
},
"completeOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Completed On or After",
"format": "date-time",
"type": "string"
},
"createdBefore": {
"description": "Format - date-time (as date-time in RFC3339). Created date before",
"format": "date-time",
"type": "string"
},
"createdOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Created date on or after",
"format": "date-time",
"type": "string"
},
"customerId": {
"description": "Format - int64. Customer Id",
"type": "integer"
},
"employeeTaskResolutionIds": {
"description": "EmployeeTaskResolution Ids (comma separated Ids)",
"type": "string"
},
"employeeTaskSourceIds": {
"description": "EmployeeTaskSource Ids (comma separated Ids)",
"type": "string"
},
"employeeTaskTypeIds": {
"description": "EmployeeTaskType Ids (comma separated Ids)",
"type": "string"
},
"ids": {
"description": "Task Ids (comma separated Ids)",
"type": "string"
},
"includeSubtasks": {
"description": "Include Subtasks",
"type": "boolean"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": "boolean"
},
"involvedEmployeeIdList": {
"description": "Involved Employee Ids (comma separated Ids)",
"type": "string"
},
"isClosed": {
"description": "Is Closed\nThis property is deprecated. Use Statuses instead.",
"type": "boolean"
},
"jobId": {
"description": "Format - int64. Job Id",
"type": "integer"
},
"jobNumber": {
"description": "Job Number",
"type": "string"
},
"modifiedBefore": {
"description": "Format - date-time (as date-time in RFC3339). Modified date before",
"format": "date-time",
"type": "string"
},
"modifiedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Modified date on or after",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name",
"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"
},
"priorities": {
"description": "Priorities (comma separated values)",
"type": "string"
},
"projectId": {
"description": "Format - int64. Project Id",
"type": "integer"
},
"reportedBefore": {
"description": "Format - date-time (as date-time in RFC3339). Reported date before",
"format": "date-time",
"type": "string"
},
"reportedById": {
"description": "Format - int64. Reported By Id",
"type": "integer"
},
"reportedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Reported On or After",
"format": "date-time",
"type": "string"
},
"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, DescriptionModifiedOn, CompletedBy, Priority",
"type": "string"
},
"statuses": {
"description": "Task Status",
"type": "string"
},
"taskNumber": {
"description": "Format - int64. Task Number",
"type": "integer"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}