# FieldEdge Open API

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

## API Docs
- Lead [Creates a new lead with customer details, appointment preferences, and service information.](https://docs-dev.fieldedge.com/creates-a-new-lead-with-customer-details-appointment-preferences-and-service-information-31171518e0.md): Creates a new lead record in the system.
- Lead [Fetches lead details based on the provided lead identifier.](https://docs-dev.fieldedge.com/fetches-lead-details-based-on-the-provided-lead-identifier-31171519e0.md): Retrieves the details of a lead by its unique identifier.
- Customer [Creates a new customer](https://docs-dev.fieldedge.com/creates-a-new-customer-31171507e0.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/updates-an-existing-customer-31171508e0.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 [Search customers by phone, email, or first name](https://docs-dev.fieldedge.com/search-customers-by-phone-email-or-first-name-31171509e0.md): Retrieves customers that match one or more of the provided search criteria: phone number, email address, or first name.
- Customer [Search customers based on address details.](https://docs-dev.fieldedge.com/search-customers-based-on-address-details-31171510e0.md): Search and retrieve customers by address information.
- Customer [Get customer details by ID](https://docs-dev.fieldedge.com/get-customer-details-by-id-31171511e0.md): Retrieves customer details using the unique customer identifier.
- Webhook [Registers a new webhook endpoint to receive event notifications.](https://docs-dev.fieldedge.com/registers-a-new-webhook-endpoint-to-receive-event-notifications-31171520e0.md): Registers a new webhook endpoint for event notifications.
- Item [Creates a new inventory item](https://docs-dev.fieldedge.com/creates-a-new-inventory-item-31171512e0.md): Creates a new inventory item with name, cost, rate, optional category, image, and tax information.
- Item [Retrieve a paginated list of inventory items with optional filters](https://docs-dev.fieldedge.com/retrieve-a-paginated-list-of-inventory-items-with-optional-filters-31171513e0.md): Retrieves a paginated list of items. Supports filtering by category, active status, and sorting.
- Item [Updates an existing inventory item](https://docs-dev.fieldedge.com/updates-an-existing-inventory-item-31171514e0.md): Updates an inventory item by itemId. Only mutable fields such as name, description, cost, rate, category, image, and tax information can be updated.
- Item [Retrieve an inventory item by ID](https://docs-dev.fieldedge.com/retrieve-an-inventory-item-by-id-31171515e0.md): Retrieves a single inventory item using its unique identifier.
- ItemCategory [Get List of itemCategories.](https://docs-dev.fieldedge.com/get-list-of-itemcategories-31171516e0.md): Get list of itemCategories with filters and sort parameter
- ItemCategory [Get item category by id.](https://docs-dev.fieldedge.com/get-item-category-by-id-31171517e0.md): Get single item category by id
- Company [Get company name by ID](https://docs-dev.fieldedge.com/get-company-name-by-id-31171521e0.md): Returns the company name for the given company ID.