Raw schema
{
"type": "object",
"properties": {
"entity_type": {
"description": "Scope by entity type; required with entity_id.",
"type": "string",
"enum": [
"Rental",
"RentalOwner",
"Association"
]
},
"entity_id": {
"description": "The entity matching entity_type id (positive 32-bit integer).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
},
"statuses": {
"description": "Statuses of the associated task: New, InProgress, Completed, Deferred or Closed.",
"type": "array",
"items": {
"type": "string",
"enum": [
"New",
"InProgress",
"Completed",
"Deferred",
"Closed"
]
}
},
"type": {
"description": "Type of the associated task.",
"type": "string",
"enum": [
"ContactRequest",
"ResidentRequest",
"Todo",
"RentalOwnerRequest"
]
},
"unit_id": {
"description": "The unit id (positive 32-bit integer).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
},
"unit_agreement_id": {
"description": "The unit agreement (lease) id (positive 32-bit integer).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
},
"due_date_from": {
"description": "Due on or after โ formatted YYYY-MM-DD.",
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"due_date_to": {
"description": "Due on or before โ formatted YYYY-MM-DD.",
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"last_updated_from": {
"description": "Updated on or after โ formatted YYYY-MM-DD.",
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"last_updated_to": {
"description": "Updated on or before โ formatted YYYY-MM-DD.",
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"task_category_id": {
"description": "The task category id (positive 32-bit integer).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
},
"priorities": {
"description": "Priorities.",
"type": "array",
"items": {
"type": "string",
"enum": [
"Low",
"Normal",
"High"
]
}
},
"assigned_to_id": {
"description": "The assigned staff user id (positive 32-bit integer).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
},
"vendor_ids": {
"description": "Filter to these vendor ids (positive 32-bit integers).",
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
}
},
"amount_from": {
"description": "Total amount at least this; must be at most amount_to when both are supplied.",
"type": "number"
},
"amount_to": {
"description": "Total amount at most this; must be at least amount_from when both are supplied.",
"type": "number"
},
"is_billed": {
"description": "Only work orders that do / do not have a bill.",
"type": "boolean"
},
"title": {
"description": "Title contains this value.",
"type": "string"
},
"task_ids": {
"description": "Filter to these task ids (positive 32-bit integers).",
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 2147483647
}
},
"limit": {
"description": "Max results, 1-1000 (Buildium default 50).",
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"offset": {
"description": "Zero-based record offset for paging (default 0).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"orderby": {
"description": "Sort, e.g. \"Name\", \"LeaseToDate desc\" or \"Rent desc,City asc\". A top-level field of the returned items; Buildium rejects other fields.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}