Raw schema
{
"type": "object",
"properties": {
"job_type": {
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
},
{
"type": "number",
"const": 3
}
],
"description": "Task type: 0 = pickup, 1 = delivery, 2 = appointment, 3 = field workforce (FOS)."
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Start of the task-date range, YYYY-MM-DD."
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "End of the task-date range, YYYY-MM-DD (at most 31 days after start_date)."
},
"job_status": {
"description": "Only tasks in this status. Task status codes: 0 assigned, 1 started, 2 successful, 3 failed, 4 in progress/arrived, 6 unassigned, 7 accepted/acknowledged, 8 declined, 9 cancelled, 10 deleted.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
},
{
"type": "number",
"const": 3
},
{
"type": "number",
"const": 4
},
{
"type": "number",
"const": 6
},
{
"type": "number",
"const": 7
},
{
"type": "number",
"const": 8
},
{
"type": "number",
"const": 9
},
{
"type": "number",
"const": 10
}
]
},
"fleet_id": {
"description": "Only tasks of this agent (from tookan_list_agents).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"team_id": {
"description": "Only tasks of this team (from tookan_list_teams).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"customer_id": {
"description": "Only tasks of this customer (from tookan_list_customers).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"job_ids": {
"description": "Only these task (job) ids.",
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"order_ids": {
"description": "Only tasks with these order ids (your own reference).",
"maxItems": 100,
"type": "array",
"items": {
"type": "string"
}
},
"custom_fields": {
"description": "Include the tasks' custom-field data.",
"type": "boolean"
},
"page": {
"default": 1,
"description": "Page number (default 1). Tookan pages are a fixed size.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 10000
}
},
"required": [
"job_type",
"start_date",
"end_date"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}