FieldEdge Open API
Docs
APIs
Docs
APIs
  1. Resources
  • Welcome to the FieldEdge Developer Portal
  • Authentication
    • Member Authentication Guide
    • Partner Authentication Guide
  • Resources
    • Leads
    • Customer
  • Support
    • API Support
Docs
APIs
Docs
APIs
  1. Resources

Leads

The API exposes three main capabilities:#

1. Creating Leads#

External systems submit new leads using a structured payload containing:
Customer information
Appointment preferences
Service request details

Typical Use Cases#

A website “Request Service” form
A mobile app allowing users to request service
A partner platform sending leads into your operations system
Once created, the API returns a unique lead identifier that can be stored and referenced in your system.

2. Retrieving Lead Details#

Systems that need to display or track existing leads can request detailed information by providing the lead’s unique identifier.

Common Use Cases#

CRM or call center applications that allow staff to review customer data
Reporting dashboards that show lead details
Automated workflows that make decisions based on the status or content of a lead

Returned Data Includes#

Customer profile
Service request information
Appointment preferences
Metadata
Current lead status

3. Registering Webhooks#

A webhook allows your system to receive real-time notifications when important lead events occur.

Why Use Webhooks?#

Avoid polling the API repeatedly
Receive instant updates for downstream workflows
Integrate with marketing automation or CRM systems
After registering a webhook URL, your system will receive event-based callbacks from FieldEdge whenever applicable lead-related events occur.
Modified at 2026-02-26 11:50:55
Previous
Partner Authentication Guide
Next
Customer
Built with