Raw schema
{
"type": "object",
"properties": {
"status": {
"description": "Only work orders in this status.",
"type": "string",
"enum": [
"open",
"onHold",
"inProgress",
"complete"
]
},
"is_complete": {
"description": "true = only completed work orders, false = only not yet completed.",
"type": "boolean"
},
"archived": {
"description": "true = only archived work orders.",
"type": "boolean"
},
"priority": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
},
"category": {
"description": "Only this work order category (e.g. Electrical).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"title": {
"description": "Only work orders with exactly this title.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"asset": {
"description": "Only records for this asset id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"location": {
"description": "Only records for this location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_to_user": {
"description": "Only records for this assigned user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_by_user": {
"description": "Only records for this assigning user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"public_requester_email": {
"description": "Only work orders created by this email through the request portal.",
"type": "string",
"minLength": 1,
"maxLength": 254
},
"due_after": {
"description": "Due at or after this time. ISO 8601.",
"type": "string"
},
"due_before": {
"description": "Due at or before this time. ISO 8601.",
"type": "string"
},
"completed_after": {
"description": "Completed at or after this time. ISO 8601.",
"type": "string"
},
"completed_before": {
"description": "Completed at or before this time. ISO 8601.",
"type": "string"
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt, dueDate, endDueDate, dateCompleted (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, assignedToUser, assignedByUser, requestedByUser, completedByUser, team.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}