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 details by ID

GET
/v1/customers/id/{customerId}
Retrieves customer details using the unique customer identifier.
Required scope: customers:read

Request

Path Params

Responses

🟢200
application/json
Customer details 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/customers/id/'
Response Response Example
200 - response
{
    "id": "c9a1f6c2-8c2b-4c91-9f7b-2e5b8b0d3a01",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "Acme Heating Services",
    "displayName": "John Doe - Acme Heating Services",
    "address1": "123 Main St",
    "address2": "Suite 200",
    "city": "Dallas",
    "state": "TX",
    "zip": "75201",
    "billingAddress1": "123 Main St",
    "billingAddress2": "Suite 200",
    "billingCity": "Dallas",
    "billingState": "TX",
    "billingZip": "75201",
    "primaryPhone": "+1-214-555-0198",
    "primaryEmail": "john.doe@acmeheating.com",
    "contactOnPhone": true,
    "contactOnSms": true,
    "contactOnEmail": true,
    "active": true,
    "billFromOffice": false,
    "parentCustomerId": "a7b2d1e3-5f89-4b1d-9a6e-2c9b8f2a0b44"
}
Modified at 2026-06-03 05:20:06
Previous
Retrieve customers based on address details.
Next
Updates an existing customer
Built with