FieldEdge Open API
dev
  • production
  • dev
DocsAPIs
DocsAPIs
dev
  • production
  • dev
dev
  • production
  • dev
  1. Employee
  • 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 customers by phone, email, or first name
      GET
    • Retrieve customer details by ID
      GET
    • Retrieve customers based on address details.
      GET
  • Item Category
    • Retrieve list of item categories
      GET
    • Retrieve item category by id.
      GET
    • Create a new item category
      POST
    • Partially update an item category
      PATCH
  • Item
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Retrieve an inventory item by ID
      GET
    • Creates a new inventory item
      POST
    • Updates an existing inventory item
      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
  • Employee
    • Retrieve a paginated list of employees
      GET
    • Retrieve an employee by ID
      GET
  • Company
    • Retrieve company name by ID
      GET
  • WorkOrder
    • Retrieve a work order by ID
  • Invoice
    • Retrieve an invoice by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Rotate the HMAC signing secret for the registered webhook.
    • Delete the registered webhook for the authenticated account.
  1. Employee

Retrieve a paginated list of employees

GET
/v1/employees
Retrieves a paginated list of employees. Supports filtering by active status and sorting.

Request

Query Params

Responses

🟢200
application/json
Employees retrieved successfully
Bodyapplication/json

🟠400
🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://dev.api.fieldedge.com/open-api/v1/employees?offset=undefined&limit=undefined&filter[active]=undefined&filter[role]=undefined'
Response Response Example
200 - response
{
    "total": 2,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "id": "FE-EMP-100",
            "name": "John Smith",
            "email": "john.smith@company.com",
            "role": "TECHNICIAN",
            "active": true
        },
        {
            "id": "FE-EMP-101",
            "name": "Jane Doe",
            "email": "jane.doe@company.com",
            "role": "ADMINISTRATOR",
            "active": true
        }
    ]
}
Modified at 2026-05-21 10:40:18
Previous
Retrieve a warehouse by ID
Next
Retrieve an employee by ID
Built with