Field NationDeveloper Platform
Field NationDeveloper Platform
IntroductionQuick StartAPI Playground

Getting Started

API Reference

Overview
TasksCustom FieldsMilestonesTime LogsSignaturesCompliance
Work OrdersExecution

Tasks

Manage task checklists that providers must complete.

Tasks

Tasks are a checklist of items the provider must complete. They can be mandatory for closing the work order.

List Tasks

GET /workorders/{id}/tasks

Response

{
  "results": [
    {
      "id": 101,
      "description": "Take photo of serial number",
      "group": { "id": "Completion Requirements" },
      "label": "Serial Number"
    },
    {
      "id": 102,
      "description": "Customer sign-off",
      "group": { "id": "Verification" },
      "label": "Sign-off"
    }
  ]
}

Create Task

POST /workorders/{id}/tasks

{
  "description": "Take a photo of the serial number",
  "group": "Completion Requirements",
  "required": true
}

Update Task

PUT /workorders/{id}/tasks/{task_id}

{
  "description": "Take a photo of BOTH serial numbers",
  "required": true
}

Delete Task

DELETE /workorders/{id}/tasks/{task_id}

Tasks can only be deleted if they haven't been completed yet.

Task Completion

Providers complete tasks via the mobile app or API:

PUT /workorders/{id}/tasks/{task_id}

{
  "completed": true
}

Task Alerts

Clear alerts for incomplete or overdue tasks.

DELETE /workorders/{id}/tasks/{task_id}/alerts

DELETE /workorders/{id}/tasks/{task_id}/alerts/{alert_id}

Related

  • Compliance - Qualifications and requirements
  • Signatures - Digital signature capture

Last updated on

Smart Dispatch

Automate routing using detailed logic and rules.

Custom Fields

Manage custom fields on work orders for buyer and provider data.

On this page

Tasks
List Tasks
Response
Create Task
Update Task
Delete Task
Task Completion
Task Alerts
Related