FieldEdge MCP by usefulapi

WRITE: attach an existing tag to a customer; it shows on the customer record in FieldEdge. Needs scope customers:write. POST /open-api/v1/customers/{customerId}/tags.

WRITE: schedule a technician on a work order. The assignment appears on the Dispatch Board at once and FieldEdge returns no assignment id: list the assignments afterwards to find it. Needs scope workorders:write. POST /open-api/v1/work-orders/{workOrderId}/assignments.

WRITE: create a customer record in FieldEdge, visible to the office staff at once. Needs an e-mail or a phone number (international format, e.g. +14155552671); marketing_email_opt_in needs an e-mail and marketing_sms_opt_in a phone number. Names are 2-50 characters without digits. Check fieldedge_search_customers first so you do not create a duplicate. Needs scope customers:write. POST /open-api/v1/customers.

WRITE: add a free-text note to a customer record; office staff see it in FieldEdge at once. Needs scope customers:write. POST /open-api/v1/customers/{customerId}/notes.

WRITE: create a reusable customer tag (e.g. "VIP Customer"). Check fieldedge_list_tags first. Needs scope customers:write. POST /open-api/v1/tags.

WRITE: create a work order for a customer location. business_unit_id, lead_source_id and task_id are required: get them from fieldedge_list_business_units, fieldedge_list_lead_sources and fieldedge_list_tasks. Scheduling, invoice lines and equipment are separate steps (fieldedge_assign_technician for scheduling). Needs scope workorders:write. POST /open-api/v1/work-orders.

One service agreement by id. Needs scope workorders:read. GET /open-api/v1/agreements/{agreement_id}.

One business unit by id. Needs scope business-units:read. GET /open-api/v1/business-units/{business_unit_id}.

The company name for a company id (the tenant id). Needs scope company:read. GET /open-api/v1/companies/{company_id}.

One customer (or job location) by id, with contact details and address (personal data). The reply says whether the record is a job or a billing customer. Needs scope customers:read. GET /open-api/v1/customers/id/{customer_id}.

The customer with this phone number (personal data). Needs scope customers:read. GET /open-api/v1/customer/{phone}.

One employee record. Needs scope employees:read. GET /open-api/v1/employees/{employee_id}.

One invoice with its line items; the invoice id equals its work order id. Needs scope invoices:read. GET /open-api/v1/invoices/{invoice_id}.

One inventory item by id. Needs scope items:read. GET /open-api/v1/items/{item_id}.

One item category by id. Needs scope item-categories:read. GET /open-api/v1/item-categories/{item_category_id}.

One lead by id (lead-provider integrations). Needs scope leads:read. GET /open-api/v1/leads/{lead_id}.

One lead source by id. Needs scope lead-sources:read. GET /open-api/v1/lead-sources/{lead_source_id}.

One quote with its line items; the quote id equals its work order id. Needs scope workorders:read. GET /open-api/v1/quotes/{quote_id}.

One task together with its resolved department and skill. Needs scope tasks:read. GET /open-api/v1/tasks/{task_id}/bundle.

One warehouse by id. Needs scope warehouses:read. GET /open-api/v1/warehouses/{warehouse_id}.

One work order: status, assignments, service address, task, tags and linked invoice. Needs scope workorders:read. GET /open-api/v1/work-orders/{work_order_id}.

Service agreements (recurring maintenance contracts) with plan, dates and customer. Needs scope workorders:read. GET /open-api/v1/agreements.

Business units (needed to create a work order). Needs scope business-units:read. GET /open-api/v1/business-units.

File attachments on a customer record, each with the blob URL to view or download it. Needs scope customers:read. GET /open-api/v1/customers/{customerId}/attachments.

Notes on a customer record, newest first by default. Needs scope customers:read. GET /open-api/v1/customers/{customerId}/notes.

Employees (technicians, dispatchers, CSRs, admins). Needs scope employees:read. GET /open-api/v1/employees.

Invoices by invoice date, without line items (use fieldedge_get_invoice for those). Needs scope invoices:read. GET /open-api/v1/invoices.

Inventory item categories (tree: childTreeLevel, parent). Needs scope item-categories:read. GET /open-api/v1/item-categories.

Inventory items (parts, services) with cost and rate. Needs scope items:read. GET /open-api/v1/items.

Lead sources (needed to create a work order). Needs scope lead-sources:read. GET /open-api/v1/lead-sources.

Quotes, without line items (use fieldedge_get_quote for those). Prefer class_id over class_name. Needs scope workorders:read. GET /open-api/v1/quotes.

Sales tax codes. Needs scope items:read. GET /open-api/v1/sales-tax-codes.

Reusable customer tags of the account. Needs scope customers:read. GET /open-api/v1/tags.

Tasks (service types, needed to create a work order). Needs scope tasks:read. GET /open-api/v1/tasks.

Inventory warehouses. Needs scope warehouses:read. GET /open-api/v1/warehouses.

Technician assignments (schedule, status) on one work order. Needs scope workorders:read. GET /open-api/v1/work-orders/{workOrderId}/assignments.

List work orders (jobs) of the company with status, service address, customer, primary technician and linked invoice. Filters combine with AND; assigned=false cannot be combined with primary_tech_id. Needs scope workorders:read. GET /open-api/v1/work-orders.

WRITE: unassign one technician (by assignment id) from a work order; other technicians on it stay. Get the assignment id from fieldedge_list_work_order_assignments. Needs scope workorders:write. DELETE /open-api/v1/work-orders/{workOrderId}/assignments/{assignmentId}.

WRITE: detach a tag from a customer (the tag itself stays). Needs scope customers:write. DELETE /open-api/v1/customers/{customerId}/tags/{tagId}.

Search customers (personal data). With no filter all customers are listed. Needs scope customers:read. GET /open-api/v1/customers/search.

Customers at a street address (personal data). address_line_1, city, state and postal_code are required. Needs scope customers:read. GET /open-api/v1/customers/by-address.

Work orders at a service address, most recent first, each with its customer's name. All of address_line_1, city, state and postal_code are required. Needs scope workorders:read. GET /open-api/v1/work-orders/search/by-address.

WRITE: move an assignment to pending, traveling, working, paused, completed or canceled. It triggers the same customer notifications and dispatch-board updates as a change on the dispatch board and is timestamped now. Canceling needs cancel_note; it fails once the assignment is completed, canceled or finalized. Get the assignment id from fieldedge_list_work_order_assignments. Needs scope workorders:write. PATCH /open-api/v1/work-orders/{workOrderId}/assignments/{assignmentId}/status.

WRITE: replace the text of an existing customer note (the old text is lost). Get the note id from fieldedge_list_customer_notes. Needs scope customers:write. PATCH /open-api/v1/customers/{customerId}/notes/{noteId}.

WRITE: partially update a work order; only the fields you pass change. Can reassign the primary technician, change description/notes, and mark it completed (with a resolution) or cancel it (cancel_note). Look at fieldedge_get_work_order first. Needs scope workorders:write. PATCH /open-api/v1/work-orders/{workOrderId}.