FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. Task
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Updates an existing customer
      PUT
    • Retrieve customer by phone number
      GET
    • Search customers with optional filters
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer details by ID
      GET
  • CustomerAttachments
    • Upload a file attachment to a customer record
      POST
    • Retrieve attachments for a customer
      GET
  • CustomerNotes
    • Create a note on a customer record
      POST
    • Retrieve all notes for a customer
      GET
    • Update an existing customer note
      PATCH
  • CustomerTags
    • Associate a tag with a customer
      POST
    • Remove a tag from a customer
      DELETE
    • Create a reusable customer tag
      POST
    • Retrieve tags
      GET
  • Item
    • Creates a new inventory item
      POST
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Bulk update inventory items
      PATCH
    • Updates an existing inventory item
      PATCH
    • Retrieve an inventory item by ID
      GET
    • Retrieve availability of an item across one or more warehouses
      GET
  • ItemCategory
    • Retrieve list of item categories
    • Create a new item category
    • Retrieve item category by id.
    • Partially update an item category
  • SalesTaxCode
    • Retrieve list of sales tax codes
  • WorkOrder
    • Retrieve a paginated list of work orders
    • Retrieve a work order by ID
    • Retrieve work orders at a given address, most recent first
    • Create a new work order
    • Update an existing work order
    • Retrieve list of business units
    • Retrieve business unit by id.
    • Retrieve list of lead sources
    • Retrieve lead source by id.
  • Assignments
    • Retrieve all technician assignments for a work order
    • Assign a technician to a work order
  • Agreement
    • Retrieve list of agreements
    • Retrieve agreement by id.
  • Invoice
    • Retrieve a paginated list of invoices
    • Retrieve an invoice by ID
  • Quote
    • Retrieve a paginated list of quotes
    • Retrieve a quote by ID
  • Task
    • Retrieve a task bundle by ID
      GET
    • Retrieve a list of tasks
      GET
  • Warehouse
    • Create a new warehouse
    • Retrieve a paginated list of warehouses
    • Update an existing warehouse
    • Retrieve a warehouse by ID
  • Employee
    • Retrieve a paginated list of employees
    • Retrieve an employee by ID
  • Company
    • Retrieve company name by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Delete the registered webhook for the authenticated account.
    • Rotate the HMAC signing secret for the registered webhook.
  1. Task

Retrieve a list of tasks

GET
/v1/tasks
Returns a list of tasks.
Required scope: tasks:read

Request

Authorization
or
Query Params

Responses

🟢200
application/json
Task list retrieved successfully
Bodyapplication/json

🟠400
🟠401
🟠403
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dev.api.fieldedge.com/open-api/v1/tasks?offset=&limit=&class=&active=&sort='
Response Response Example
200 - Sample task list response
{
    "total": 2,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "taskId": "a319703d-a0f2-42e5-a38d-55a71155d906",
            "name": "HVAC Maintenance",
            "active": true,
            "minutesToComplete": 60,
            "globalBusUnits": false,
            "classId": "03809a62-775b-44a2-bf47-0491c999525d"
        },
        {
            "taskId": "bf51d59d-2866-4f1c-8c63-bb6319531cb2",
            "name": "Rust Free Salt",
            "active": true,
            "minutesToComplete": 60,
            "globalBusUnits": false,
            "classId": "a3809a62-775b-44a2-bf47-0491c999527e"
        }
    ]
}
Modified at 2026-08-27 11:27:54
Previous
Retrieve a task bundle by ID
Next
Create a new warehouse
Built with