purchase_orders_getrequests
Retrieve purchase order requests in ServiceTitan by filtering with tenant ID, status, job ID, technician ID, or date ranges. Supports pagination and sorting for precise querying.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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) | |
| dateBefore | No | Format - date-time (as date-time in RFC3339). Return PO requests with date before certain date/time | |
| dateOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return PO requests with date on or after certain date/time | |
| ids | No | ||
| includeTotal | No | Whether total count should be returned | |
| jobId | No | Format - int64. Filters by JobId associated with PO request | |
| jobIds | No | Filters by JobIds associated with PO request | |
| 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) | |
| 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) | |
| projectId | No | Format - int64. Filter by ProjectId associated with PO request | |
| requestNumber | No | Filters by PO request number | |
| requestStatus | No | Filters by PO request status Available values are: PendingApproval, Rejected\ Values: [PendingApproval, Approved, Rejected] | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
| technicianId | No | Format - int64. Filter by TechnicianId associated with PO request | |
| 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). Return items created before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"createdOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"dateBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return PO requests with date before certain date/time",
"type": [
"string",
"null"
]
},
"dateOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return PO requests with date on or after certain date/time",
"type": [
"string",
"null"
]
},
"ids": {
"type": [
"string",
"null"
]
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"jobId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Filters by JobId associated with PO request"
},
"jobIds": {
"description": "Filters by JobIds associated with PO request",
"type": [
"string",
"null"
]
},
"modifiedBefore": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)",
"type": [
"string",
"null"
]
},
"modifiedOnOrAfter": {
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)",
"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)"
},
"projectId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Filter by ProjectId associated with PO request"
},
"requestNumber": {
"description": "Filters by PO request number ",
"type": [
"string",
"null"
]
},
"requestStatus": {
"description": "Filters by PO request status\nAvailable values are: PendingApproval, Rejected\\\nValues: [PendingApproval, Approved, Rejected]",
"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, ModifiedOn, CreatedOn.",
"type": [
"string",
"null"
]
},
"technicianId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64. Filter by TechnicianId associated with PO request"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}