Kickserv APIv2 - Employee 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.

For most applications, the bulk of the employee object data is not terribly useful, and much as of it deals with how the web UI behaves for that employee. Depending on which endpoint is being interrogated an abbreviated version of the object may be returned.

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

{
"id": 4444,
"account_id": 999,
"list_id": null,
"edit_sequence": null,
"employee_number": 1,
"hired_date": null,
"created_at": "2014-08-06T09:12:52-04:00",
"name": "Jason L.",
"username": "jason",
"password_salt": "HPosyUMhs%tgx3NCBuzY",
"encrypted_password": "cfdd22af15aa6h886a4ed3ef4788w2wd07sc73a0d8cca6e",
"email_address": "jason@yourdomain.com",
"is_account_owner": true,
"active": true,
"can_login": true,
"address": "",
"city": "",
"state": "",
"zip_code": "",
"home_phone": "",
"cell_phone": "+12223334444",
"pager": "",
"notify_via_email": true,
"notify_via_mobile": true,
"notification_email_address": "jason@yourdomain.com",
"notification_mobile_number": "1112223333",
"notification_mobile_host": null,
"remember_token": "yym6wkJsyLLuFfgm4icp4",
"remember_me_token_expires_at": null,
"custom_text1": null,
"custom_number1": null,
"custom_datetime1": null,
"custom_text2": null,
"custom_number2": null,
"custom_datetime2": null,
"custom_text3": null,
"custom_number3": null,
"custom_datetime3": null,
"custom_text4": null,
"custom_number4": null,
"custom_datetime4": null,
"custom_text5": null,
"custom_number5": null,
"custom_datetime5": null,
"custom_text6": null,
"custom_number6": null,
"custom_datetime6": null,
"custom_text7": null,
"custom_number7": null,
"custom_datetime7": null,
"custom_text8": null,
"custom_number8": null,
"custom_datetime8": null,
"custom_text9": null,
"custom_number9": null,
"custom_datetime9": null,
"custom_text10": null,
"custom_number10": null,
"custom_datetime10": null,
"all_tasks_ical_hash": "84e93847e7376faba8aa9dd1f48760fe",
"public_tasks_ical_hash": "8e35b24a9ee7dd093f33201a1955",
"jobs_ical_hash": "2fc0987dba36188a4c7b0738a",
"updated_at": "2022-06-04T09:57:09-04:00",
"email_schedule_daily": false,
"tech": true,
"limit_access_to_assignments": false,
"api_token": "4g556hfgfffffffffff",
"hide_pricing": false,
"show_setup_tab": false,
"activity_ical_hash": "h5ff3gfgh433d356c3426ce0bb14f90",
"notify_on_tasks": false,
"admin": true,
"notify_on_tasks_by_sms": false,
"beta_mode": false,
"always_send_daily_schedule": false,
"latitude": null,
"longitude": null,
"sales": false,
"avatar": null,
"email_agenda_daily": false,
"intuit_uid": null,
"failed_attempts": 0,
"locked_at": null,
"reset_password_token": null,
"reset_password_sent_at": null,
"availability": [],
"receives_message_notifications": true,
"use_company_hours": true,
"setup_token": null,
"google_api_access_token": null,
"google_api_token_type": null,
"google_api_token_expires_at": null,
"google_api_refresh_token": null,
"google_calendar_id": null,
"sync_all_tasks": false,
"hours": {},
"color": "#0c48e5",
"settings": {
"calendar": {
"last_hour": 18,
"first_hour": 6,
"hide_reminders": false,
"show_lost_opps": true,
"show_canceled_jobs": true,
"confirm_when_dragging": true,
"show_expanded_hour_view": false
},
"sort_settings": {
"jobs": {
"tabs": {
"complete": {
"date": "DESC"
}
}
},
"customers": {
"tabs": {
"jobs": {
"completed_on": "DESC"
},
"invoices": {
"created_at": "DESC"
},
"payments": {
"created_at": "DESC"
},
"opportunities": {
"created_at": "DESC"
}
}
}
},
"dispatch_calendar": {
"last_hour": 18,
"first_hour": 6,
"hide_reminders": false,
"show_lost_opps": true,
"show_canceled_jobs": true,
"confirm_when_dragging": true,
"show_expanded_hour_view": false
}
},
"remember_created_at": "2022-06-04T09:57:09-04:00",
"unlock_token": null,
"session_token": null,
"place_id": null,
"place_id_retrieved_at": null
}