> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/field-service.md). # Field service Employees in the field, the tasks assigned to them, and what they report back. Field service covers work done away from a desk: the employees who do it, the tasks and routes assigned to them, the places they visit, and the forms and check-ins they send back from site. [Task](/docs/navixy-api/user-api/resources/field-service/task.md) is the centre of it, and [Employee](/docs/navixy-api/user-api/resources/field-service/employee.md) is who a task is assigned to. [Form](/docs/navixy-api/user-api/resources/field-service/form.md) and [Check-ins](/docs/navixy-api/user-api/resources/field-service/checkin.md) are what comes back, and [Place](/docs/navixy-api/user-api/resources/field-service/place.md) is where the work happens. ## Operations in this section #### Check-ins | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------- | | [`/checkin/read`](/docs/navixy-api/user-api/resources/field-service/checkin.md#post-checkin-read) | POST | Read check-in | | [`/checkin/list`](/docs/navixy-api/user-api/resources/field-service/checkin.md#post-checkin-list) | POST | List check-ins | | [`/checkin/delete`](/docs/navixy-api/user-api/resources/field-service/checkin.md#post-checkin-delete) | POST | Delete check-ins | | [`/checkin/create`](/docs/navixy-api/user-api/resources/field-service/checkin.md#post-checkin-create) | POST | Create check-in | | [`/checkin/image/create`](/docs/navixy-api/user-api/resources/field-service/checkin.md#post-checkin-image-create) | POST | Create check-in image | | [`/checkin/form/create`](/docs/navixy-api/user-api/resources/field-service/checkin.md#post-checkin-form-create) | POST | Create check-in form | | [`/checkin/form/file/create`](/docs/navixy-api/user-api/resources/field-service/checkin.md#post-checkin-form-file-create) | POST | Create check-in form file | #### Departments | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------- | ------ | ----------------- | | [`/department/list`](/docs/navixy-api/user-api/resources/field-service/department.md#post-department-list) | POST | List departments | | [`/department/create`](/docs/navixy-api/user-api/resources/field-service/department.md#post-department-create) | POST | Create department | | [`/department/update`](/docs/navixy-api/user-api/resources/field-service/department.md#post-department-update) | POST | Update department | | [`/department/delete`](/docs/navixy-api/user-api/resources/field-service/department.md#post-department-delete) | POST | Delete department | #### Employee | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------- | | [`/employee/list`](/docs/navixy-api/user-api/resources/field-service/employee.md#post-employee-list) | POST | List employees | | [`/employee/create`](/docs/navixy-api/user-api/resources/field-service/employee.md#post-employee-create) | POST | Create employee | | [`/employee/read`](/docs/navixy-api/user-api/resources/field-service/employee.md#post-employee-read) | POST | Read employee | | [`/employee/update`](/docs/navixy-api/user-api/resources/field-service/employee.md#post-employee-update) | POST | Update employee | | [`/employee/delete`](/docs/navixy-api/user-api/resources/field-service/employee.md#post-employee-delete) | POST | Delete employee | | [`/employee/batch_convert`](/docs/navixy-api/user-api/resources/field-service/employee.md#post-employee-batch_convert) | POST | Convert employee batch | #### Employee avatar | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------- | | [`/employee/avatar/assign`](/docs/navixy-api/user-api/resources/field-service/employee/avatar.md#post-employee-avatar-assign) | POST | Assign employee icon | | [`/employee/avatar/upload`](/docs/navixy-api/user-api/resources/field-service/employee/avatar.md#post-employee-avatar-upload) | POST | Upload employee avatar | #### Employee import | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------------- | | [`/employee/import/start`](/docs/navixy-api/user-api/resources/field-service/employee/import.md#post-employee-import-start) | POST | Start employee import | | [`/employee/import/read`](/docs/navixy-api/user-api/resources/field-service/employee/import.md#post-employee-import-read) | POST | Read employee import | | [`/employee/import/list`](/docs/navixy-api/user-api/resources/field-service/employee/import.md#post-employee-import-list) | POST | List employee imports | | [`/employee/import/download_failed`](/docs/navixy-api/user-api/resources/field-service/employee/import.md#post-employee-import-download_failed) | POST | Download failed employee rows | #### Form | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------ | ------ | ------------- | | [`/form/read`](/docs/navixy-api/user-api/resources/field-service/form.md#post-form-read) | POST | Read form | | [`/form/download`](/docs/navixy-api/user-api/resources/field-service/form.md#post-form-download) | POST | Download form | #### Form templates | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/form/template/list`](/docs/navixy-api/user-api/resources/field-service/form/template.md#post-form-template-list) | POST | List form templates | | [`/form/template/create`](/docs/navixy-api/user-api/resources/field-service/form/template.md#post-form-template-create) | POST | Create form template | | [`/form/template/read`](/docs/navixy-api/user-api/resources/field-service/form/template.md#post-form-template-read) | POST | Read form template | | [`/form/template/update`](/docs/navixy-api/user-api/resources/field-service/form/template.md#post-form-template-update) | POST | Update form template | | [`/form/template/delete`](/docs/navixy-api/user-api/resources/field-service/form/template.md#post-form-template-delete) | POST | Delete form template | | [`/form/template/stats/read`](/docs/navixy-api/user-api/resources/field-service/form/template.md#post-form-template-stats-read) | POST | Read template usage | #### Place avatar | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------- | ------ | ------------------- | | [`/place/avatar/upload`](/docs/navixy-api/user-api/resources/field-service/place/avatar.md#post-place-avatar-upload) | POST | Upload place avatar | | [`/place/avatar/assign`](/docs/navixy-api/user-api/resources/field-service/place/avatar.md#post-place-avatar-assign) | POST | Assign place icon | #### Place import | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------ | | [`/place/import/start`](/docs/navixy-api/user-api/resources/field-service/place/import.md#post-place-import-start) | POST | Start POI import | | [`/place/import/read`](/docs/navixy-api/user-api/resources/field-service/place/import.md#post-place-import-read) | POST | Read POI import | | [`/place/import/list`](/docs/navixy-api/user-api/resources/field-service/place/import.md#post-place-import-list) | POST | List POI imports | | [`/place/import/download_failed`](/docs/navixy-api/user-api/resources/field-service/place/import.md#post-place-import-download_failed) | POST | Download failed POI rows | | [`/place/import/finish`](/docs/navixy-api/user-api/resources/field-service/place/import.md#post-place-import-finish) | POST | Finish POI import | #### Places (POI) | Endpoint | Method | What it does | | ------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------- | | [`/place/read`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-read) | POST | Read place | | [`/place/list`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-list) | POST | List places | | [`/place/create`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-create) | POST | Create place | | [`/place/search_location`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-search_location) | POST | Search places by location | | [`/place/update`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-update) | POST | Update place | | [`/place/delete`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-delete) | POST | Delete place | | [`/place/batch_convert`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-batch_convert) | POST | Convert place batch | | [`/place/upload`](/docs/navixy-api/user-api/resources/field-service/place/work-with-poi.md#post-place-upload) | POST | Upload places | #### Task | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------- | ------ | -------------------------- | | [`/task/assign`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-assign) | POST | Assign task | | [`/task/batch_convert`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-batch_convert) | POST | Convert task batch | | [`/task/count`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-count) | POST | Count tasks | | [`/task/create`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-create) | POST | Create task | | [`/task/delete`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-delete) | POST | Delete task | | [`/task/list`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-list) | POST | List tasks | | [`/task/read`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-read) | POST | Read task | | [`/task/transmute`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-transmute) | POST | Convert task to checkpoint | | [`/task/update`](/docs/navixy-api/user-api/resources/field-service/task.md#post-task-update) | POST | Update task | #### Checkpoints | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------------- | ------ | -------------------------- | | [`/task/checkpoint/create`](/docs/navixy-api/user-api/resources/field-service/task/checkpoint.md#post-task-checkpoint-create) | POST | Create checkpoint | | [`/task/checkpoint/delete`](/docs/navixy-api/user-api/resources/field-service/task/checkpoint.md#post-task-checkpoint-delete) | POST | Delete checkpoint | | [`/task/checkpoint/list`](/docs/navixy-api/user-api/resources/field-service/task/checkpoint.md#post-task-checkpoint-list) | POST | List checkpoints | | [`/task/checkpoint/read`](/docs/navixy-api/user-api/resources/field-service/task/checkpoint.md#post-task-checkpoint-read) | POST | Read checkpoint | | [`/task/checkpoint/transmute`](/docs/navixy-api/user-api/resources/field-service/task/checkpoint.md#post-task-checkpoint-transmute) | POST | Convert checkpoint to task | | [`/task/checkpoint/update`](/docs/navixy-api/user-api/resources/field-service/task/checkpoint.md#post-task-checkpoint-update) | POST | Update checkpoint | #### Task history | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------------- | ------ | ----------------- | | [`/task/history/list`](/docs/navixy-api/user-api/resources/field-service/task/history.md#post-task-history-list) | POST | List task history | #### Form | Endpoint | Method | What it does | | --------------------------------------------------------------------------------------------------------------- | ------ | ------------------- | | [`/task/form/create`](/docs/navixy-api/user-api/resources/field-service/task/form.md#post-task-form-create) | POST | Attach form to task | | [`/task/form/delete`](/docs/navixy-api/user-api/resources/field-service/task/form.md#post-task-form-delete) | POST | Delete task form | | [`/task/form/download`](/docs/navixy-api/user-api/resources/field-service/task/form.md#post-task-form-download) | POST | Download task form | | [`/task/form/list`](/docs/navixy-api/user-api/resources/field-service/task/form.md#post-task-form-list) | POST | List forms | | [`/task/form/read`](/docs/navixy-api/user-api/resources/field-service/task/form.md#post-task-form-read) | POST | Read task form | #### Task form files | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------- | | [`/task/form/file/create`](/docs/navixy-api/user-api/resources/field-service/task/form/file.md#post-task-form-file-create) | POST | Create form file | #### Task form values | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------ | | [`/task/form/values/update`](/docs/navixy-api/user-api/resources/field-service/task/form/values.md#post-task-form-values-update) | POST | Update form values | #### Route | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------- | ------ | ------------ | | [`/task/route/assign`](/docs/navixy-api/user-api/resources/field-service/task/route.md#post-task-route-assign) | POST | Assign route | | [`/task/route/create`](/docs/navixy-api/user-api/resources/field-service/task/route.md#post-task-route-create) | POST | Create route | | [`/task/route/delete`](/docs/navixy-api/user-api/resources/field-service/task/route.md#post-task-route-delete) | POST | Delete route | | [`/task/route/list`](/docs/navixy-api/user-api/resources/field-service/task/route.md#post-task-route-list) | POST | List routes | | [`/task/route/read`](/docs/navixy-api/user-api/resources/field-service/task/route.md#post-task-route-read) | POST | Read route | | [`/task/route/update`](/docs/navixy-api/user-api/resources/field-service/task/route.md#post-task-route-update) | POST | Update route | #### Route optimization | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------- | | [`/task/route/points/optimize`](/docs/navixy-api/user-api/resources/field-service/task/route/optimize.md#post-task-route-points-optimize) | POST | Optimize route points | #### Schedule | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------- | ------ | -------------------- | | [`/task/schedule/create`](/docs/navixy-api/user-api/resources/field-service/task/schedule.md#post-task-schedule-create) | POST | Create task schedule | | [`/task/schedule/delete`](/docs/navixy-api/user-api/resources/field-service/task/schedule.md#post-task-schedule-delete) | POST | Delete task schedule | | [`/task/schedule/list`](/docs/navixy-api/user-api/resources/field-service/task/schedule.md#post-task-schedule-list) | POST | List task schedules | | [`/task/schedule/read`](/docs/navixy-api/user-api/resources/field-service/task/schedule.md#post-task-schedule-read) | POST | Read task schedule | | [`/task/schedule/update`](/docs/navixy-api/user-api/resources/field-service/task/schedule.md#post-task-schedule-update) | POST | Update task schedule | #### Task schedule checkpoints | Endpoint | Method | What it does | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------------------- | | [`/task/schedule/checkpoint/delete`](/docs/navixy-api/user-api/resources/field-service/task/schedule/checkpoint.md#post-task-schedule-checkpoint-delete) | POST | Delete schedule checkpoint | | [`/task/schedule/checkpoint/transmute`](/docs/navixy-api/user-api/resources/field-service/task/schedule/checkpoint.md#post-task-schedule-checkpoint-transmute) | POST | Convert schedule checkpoint to task | #### Schedule proposals | Endpoint | Method | What it does | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------- | | [`/task/schedule/proposal/list`](/docs/navixy-api/user-api/resources/field-service/task/schedule/proposal.md#post-task-schedule-proposal-list) | POST | List schedule proposals | #### Route schedules | Endpoint | Method | What it does | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------------- | | [`/task/schedule/route/create`](/docs/navixy-api/user-api/resources/field-service/task/schedule/route.md#post-task-schedule-route-create) | POST | Create route schedule | | [`/task/schedule/route/delete`](/docs/navixy-api/user-api/resources/field-service/task/schedule/route.md#post-task-schedule-route-delete) | POST | Delete route schedule | | [`/task/schedule/route/update`](/docs/navixy-api/user-api/resources/field-service/task/schedule/route.md#post-task-schedule-route-update) | POST | Update route schedule | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/field-service.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.