# FieldEdge Open API

## Docs
- [Welcome to the FieldEdge Developer Portal](https://docs-dev.fieldedge.com/dev/welcome-to-the-fieldedge-developer-portal-1966285m0.md): 
- Authentication [Member Authentication Guide](https://docs-dev.fieldedge.com/dev/member-authentication-guide-1981868m0.md): 
- Authentication [Partner Authentication Guide](https://docs-dev.fieldedge.com/dev/partner-authentication-guide-1981952m0.md): 
- Resources [Leads](https://docs-dev.fieldedge.com/dev/leads-1981953m0.md): 
- Resources [Customer](https://docs-dev.fieldedge.com/dev/customer-1981961m0.md): 
- Support [API Support](https://docs-dev.fieldedge.com/dev/api-support-1981962m0.md): 

## API Docs
- Lead [Creates a new lead with customer details, appointment preferences, and service information.](https://docs-dev.fieldedge.com/dev/leads.md): Creates a new lead record in the system.
- Lead [Fetches lead details based on the provided lead identifier.](https://docs-dev.fieldedge.com/dev/fetches-lead-details-based-on-the-provided-lead-identifier-32059808e0.md): Retrieves the details of a lead by its unique identifier.
- Customer [Creates a new customer](https://docs-dev.fieldedge.com/dev/creates-a-new-customer-32803944e0.md): Creates a new customer record with primary contact details, address information, preferred contact methods, and marketing opt-in preferences.
- Customer [Updates an existing customer](https://docs-dev.fieldedge.com/dev/updates-an-existing-customer-32803945e0.md): Updates an existing customer using the customerId provided in the URL. Allows modification of name, company, primary contact details (email/phone), address information, preferred contact methods (Email, Phone, SMS), and marketing opt-in preferences. The customerId must reference an existing customer in the system.
- Customer [Retrieve customers by phone, email, or first name](https://docs-dev.fieldedge.com/dev/retrieve-customers-by-phone-email-or-first-name-32803946e0.md): Retrieves customers that match one or more of the provided search criteria: phone number, email address, or first name. Supports pagination via query parameters `offset` (default 0) and `limit` (default 20).
- Customer [Retrieve customer details by ID](https://docs-dev.fieldedge.com/dev/retrieve-customer-details-by-id-32059800e0.md): Retrieves customer details using the unique customer identifier.
- Customer [Retrieve customers based on address details.](https://docs-dev.fieldedge.com/dev/retrieve-customers-based-on-address-details-32059799e0.md): Search and retrieve customers by address information. Supports pagination via query parameters `offset` (default 0) and `limit` (default 20).
- Item Category [Retrieve list of item categories](https://docs-dev.fieldedge.com/dev/retrieve-list-of-item-categories-32803953e0.md): Get list of itemCategories with filters and sort parameter
- Item Category [Retrieve item category by id.](https://docs-dev.fieldedge.com/dev/retrieve-item-category-by-id-32803954e0.md): Get single item category by id
- Item Category [Create a new item category](https://docs-dev.fieldedge.com/dev/create-a-new-item-category-36194917e0.md): Creates a new item category. Optionally nest it under a parent category by providing a non-empty parentId. ChildTreeLevel and FullName are computed server-side.
- Item Category [Partially update an item category](https://docs-dev.fieldedge.com/dev/partially-update-an-item-category-36194918e0.md): Applies a partial update to an item category by its ID. Only the fields included in the request body are updated; omitted fields retain their existing values. ChildTreeLevel, FullName, and QboID are computed/managed server-side.
- Item [Retrieve a paginated list of inventory items with optional filters](https://docs-dev.fieldedge.com/dev/retrieve-a-paginated-list-of-inventory-items-with-optional-filters-32803950e0.md): Retrieves a paginated list of items. Supports filtering by category, active status, and sorting.
- Item [Retrieve an inventory item by ID](https://docs-dev.fieldedge.com/dev/retrieve-an-inventory-item-by-id-32803952e0.md): Retrieves a single inventory item using its unique identifier.
- Item [Creates a new inventory item](https://docs-dev.fieldedge.com/dev/creates-a-new-inventory-item-32803949e0.md): Creates a new inventory item with name, cost, rate, optional category, image, and tax information.
- Item [Updates an existing inventory item](https://docs-dev.fieldedge.com/dev/updates-an-existing-inventory-item-32803951e0.md): Updates an inventory item by itemId. Only mutable fields such as name, description, cost, rate, category, image, and tax information can be updated.
- Warehouse [Create a new warehouse](https://docs-dev.fieldedge.com/dev/create-a-new-warehouse-32803955e0.md): Creates a new warehouse with the provided details.
- Warehouse [Retrieve a paginated list of warehouses](https://docs-dev.fieldedge.com/dev/retrieve-a-paginated-list-of-warehouses-32803956e0.md): Retrieves a paginated list of warehouses. Supports filtering by name, active status, and sorting.
- Warehouse [Update an existing warehouse](https://docs-dev.fieldedge.com/dev/update-an-existing-warehouse-32803957e0.md): Updates the specified warehouse with the provided details. Only the supplied fields will be updated.
- Warehouse [Retrieve a warehouse by ID](https://docs-dev.fieldedge.com/dev/retrieve-a-warehouse-by-id-32803958e0.md): Retrieves a single warehouse using its unique identifier.
- Employee [Retrieve a paginated list of employees](https://docs-dev.fieldedge.com/dev/retrieve-a-paginated-list-of-employees-32803947e0.md): Retrieves a paginated list of employees. Supports filtering by active status and sorting.
- Employee [Retrieve an employee by ID](https://docs-dev.fieldedge.com/dev/retrieve-an-employee-by-id-32803948e0.md): Retrieves a single employee record.
- Company [Retrieve company name by ID](https://docs-dev.fieldedge.com/dev/retrieve-company-name-by-id-32059795e0.md): Returns the company name for the given company ID.
- WorkOrder [Retrieve a work order by ID](https://docs-dev.fieldedge.com/dev/retrieve-a-work-order-by-id-33853433e0.md): Retrieves full details of a work order including status, assignments, service address, task information, tags, and linked invoice.
- Invoice [Retrieve an invoice by ID](https://docs-dev.fieldedge.com/dev/retrieve-an-invoice-by-id-33853432e0.md): Retrieves the invoice associated with a FieldEdge work order. The invoice ID is the same as the work order ID. Returns 404 if no work order is found or if the work order has no invoice.
- Webhook [Register a webhook endpoint to receive event notifications.](https://docs-dev.fieldedge.com/dev/register-a-webhook-endpoint-to-receive-event-notifications-32803959e0.md): Registers a callback URL that will receive real-time event notifications for work orders, invoices, item categories, and leads.
- Webhook [Rotate the HMAC signing secret for the registered webhook.](https://docs-dev.fieldedge.com/dev/rotate-the-hmac-signing-secret-for-the-registered-webhook-36194662e0.md): Generates a new HMAC-SHA256 secret for the authenticated account's webhook. The new secret replaces the previous one immediately. Store the returned secret securely — it cannot be retrieved again.
- Webhook [Delete the registered webhook for the authenticated account.](https://docs-dev.fieldedge.com/dev/delete-the-registered-webhook-for-the-authenticated-account-36194661e0.md): Removes the webhook registration for the authenticated account. Subsequent events will no longer be delivered to the callback URL.