FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. WorkOrder
  • 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
    • Retrieve a paginated list of inventory items with optional filters
    • Bulk update inventory items
    • Updates an existing inventory item
    • Retrieve an inventory item by ID
    • Retrieve availability of an item across one or more warehouses
  • 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
      GET
    • Retrieve a work order by ID
      GET
    • Retrieve work orders at a given address, most recent first
      GET
    • Create a new work order
      POST
    • Update an existing work order
      PATCH
    • Retrieve list of business units
      GET
    • Retrieve business unit by id.
      GET
    • Retrieve list of lead sources
      GET
    • Retrieve lead source by id.
      GET
  • 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
    • Retrieve a list of tasks
  • 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. WorkOrder

Retrieve list of lead sources

GET
/v1/lead-sources
Get list of lead sources with filters, pagination, and sort.
Required scope: lead-sources:read

Request

Authorization
or
Query Params

Responses

🟢200
application/json
Lead sources 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/lead-sources?active=&businessUnitId=&name=&limit=&offset=&sort='
Response Response Example
200 - Example lead source list response
{
    "total": 2,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "id": "3f1c9f1d-0d57-4c91-bc2b-2c0b7a8c1f01",
            "name": "Google Ads",
            "number": "555-200-1000",
            "active": true,
            "businessUnitId": "5c62b1b7-4f6a-4b27-8a33-93c8c3e6b902",
            "businessUnitName": "Acme Corp:North Branch",
            "isDefault": true
        },
        {
            "id": "7a4d2e3b-1234-4c91-bc2b-2c0b7a8c1f02",
            "name": "Referral",
            "number": null,
            "active": true,
            "businessUnitId": "5c62b1b7-4f6a-4b27-8a33-93c8c3e6b902",
            "businessUnitName": "Acme Corp:North Branch",
            "isDefault": false
        }
    ]
}
Modified at 2026-08-27 11:28:40
Previous
Retrieve business unit by id.
Next
Retrieve lead source by id.
Built with