Raw schema
{
"type": "object",
"properties": {
"customer": {
"description": "Only jobs of this customer id.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"assigned": {
"description": "Only jobs assigned to this team member (service provider) id.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"territory": {
"description": "Only jobs in this service territory id.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"recurring_booking": {
"description": "Only jobs that belong to this recurring booking id.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"status": {
"description": "Only jobs with this status.",
"type": "string",
"enum": [
"Scheduled",
"En-route",
"Started",
"Complete"
]
},
"canceled": {
"description": "true = only canceled jobs, false = only jobs that are not canceled.",
"type": "boolean"
},
"start_date_min": {
"description": "Only jobs scheduled to start on or after this ISO 8601 date-time.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$"
},
"start_date_max": {
"description": "Only jobs scheduled to start on or before this ISO 8601 date-time.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$"
},
"created_after": {
"description": "Only items created after this ISO 8601 date-time.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$"
},
"created_before": {
"description": "Only items created before this ISO 8601 date-time.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$"
},
"sort_by": {
"description": "Sort field (default start_time).",
"type": "string",
"enum": [
"start_time",
"creation_date"
]
},
"sort_order": {
"description": "Sort order (default ascending).",
"type": "string",
"enum": [
"ascending",
"descending"
]
},
"cursor": {
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor.",
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"limit": {
"description": "Results per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}