FieldEdge Open API
production
  • production
  • dev
DocsAPIs
DocsAPIs
production
  • production
  • dev
production
  • production
  • dev
  1. Customer
  • 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
    • Search customers with optional filters
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer details by ID
      GET
    • Updates an existing customer
      PUT
    • Retrieve customer by phone number
      GET
  • Employee
    • Retrieve a paginated list of employees
      GET
    • Retrieve an employee by ID
      GET
  • ItemCategory
    • Retrieve list of item categories
      GET
    • Create a new item category
      POST
    • Retrieve item category by id.
      GET
    • Partially update an item category
      PATCH
  • Item
    • Creates a new inventory item
      POST
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Updates an existing inventory item
      PATCH
    • Retrieve an inventory item by ID
      GET
    • Bulk update inventory items
      PATCH
  • Warehouse
    • Create a new warehouse
      POST
    • Retrieve a paginated list of warehouses
      GET
    • Update an existing warehouse
      PATCH
    • Retrieve a warehouse by ID
      GET
  • WorkOrder
    • Retrieve a work order by ID
    • Retrieve a paginated list of work orders
  • Invoice
    • Retrieve an invoice by ID
    • Retrieve a paginated list of invoices
  • 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. Customer

Retrieve customer by phone number

GET
/v1/customer/{phone}
Retrieves a customer record matching the provided phone number.
Required scope: customers:read

Request

Path Params

Responses

🟢200
application/json
Customer retrieved successfully.
Bodyapplication/json

🟢204
🟠400
🟠401
🟠403
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.fieldedge.com/open-api/v1/customer/'
Response Response Example
200 - Example 1
{
    "data": {
        "customerRefId": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "marketingEmailOptedIn": true,
        "address": {
            "addressRefId": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "city": "string",
            "state": "string",
            "postalCode": "string",
            "country": "string"
        }
    }
}
Modified at 2026-06-03 05:20:40
Previous
Updates an existing customer
Next
Retrieve a paginated list of employees
Built with