Kickserv APIv2 - Task Object

This documention is neither written nor endorsed by Kickserv. It has not been reviewed by Kickserv for accuracy and the API is entirely unsupported. It may work, it may not. You are responsible for anything that you do using the API and Kickserv can't undo it for you. Use at your own risk.

Mouseover the JSON key to see a brief description of each key. Keys that either haven't been identified (or that we haven't gotten around to adding yet) will show 'XXX'. Keys that are light gray are obsolete/legacy but still are returned in API responses.

If you're creating tasks programatically don't confuse 'employee_id' with 'employees'. 'employees' is an array of objects and 'employee_id seems to be a hold-over from some previous incarnation of task assignment.

If you spot a mistake or know the purpose of an undescribed key please let us know by emailing kickservapi@veildg.com.

Back to object map list

"tasks": [
{
"id": 666555444,
"account_id": 999,
"employee_id": null,
"name": "",
"description": null,
"completed_at": null,
"created_at": "2022-06-06T14:32:18-04:00",
"updated_at": "2022-06-06T14:32:18-04:00",
"notification_sent": false,
"creator_id": 100339,
"customer_id": 111222333,
"job_id": 39726512,
"scheduled_at": "2022-06-20T14:45:00-04:00",
"duration": 60,
"ends_at": "2022-06-20T15:45:00-04:00",
"task_type_id": 987987987,
"updated_by": null,
"recurring_item_parent_id": 666555443,
"deleted_at": null,
"estimated_time_of_arrival": null,
"task_type_name": "Work",
"employees": [
{
"id": 667788,
"account_id": 999,
"employee_number": 1,
"name": "Clarence R",
"admin": true,
"active": true,
"limit_access_to_assignments": false,
"email_address": "clarence@yourdomain.com",
"username": "clarence",
"address": "",
"city": "",
"state": "",
"zip_code": "",
"avatar": "https:path/to/avatar.png"
}
]
}
]